Documentation

AudioConfig extends Message
in package

Unified audio selection and channel routing.

Each route specifies both which audio to capture and which channel to output to.

Generated from protobuf message livekit.AudioConfig

Table of Contents

Properties

$capture_all  : mixed
If true, all unmatched audio is recorded to both channels
$routes  : mixed
Generated from protobuf field <code>repeated .livekit.AudioRoute routes = 2;</code>

Methods

__construct()  : mixed
Constructor.
getCaptureAll()  : bool
If true, all unmatched audio is recorded to both channels
getRoutes()  : RepeatedField
Generated from protobuf field <code>repeated .livekit.AudioRoute routes = 2;</code>
setCaptureAll()  : $this
If true, all unmatched audio is recorded to both channels
setRoutes()  : $this
Generated from protobuf field <code>repeated .livekit.AudioRoute routes = 2;</code>

Properties

$capture_all

If true, all unmatched audio is recorded to both channels

protected mixed $capture_all = false

Generated from protobuf field bool capture_all = 1;

$routes

Generated from protobuf field <code>repeated .livekit.AudioRoute routes = 2;</code>

private mixed $routes

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type bool $capture_all
      If true, all unmatched audio is recorded to both channels
@type array<\Livekit\AudioRoute>|\Google\Protobuf\Internal\RepeatedField $routes

}

getCaptureAll()

If true, all unmatched audio is recorded to both channels

public getCaptureAll() : bool

Generated from protobuf field bool capture_all = 1;

Return values
bool

getRoutes()

Generated from protobuf field <code>repeated .livekit.AudioRoute routes = 2;</code>

public getRoutes() : RepeatedField
Return values
RepeatedField

setCaptureAll()

If true, all unmatched audio is recorded to both channels

public setCaptureAll(bool $var) : $this

Generated from protobuf field bool capture_all = 1;

Parameters
$var : bool
Return values
$this

setRoutes()

Generated from protobuf field <code>repeated .livekit.AudioRoute routes = 2;</code>

public setRoutes(array<string|int, AudioRoute>|RepeatedField $var) : $this
Parameters
$var : array<string|int, AudioRoute>|RepeatedField
Return values
$this
On this page

Search results