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

$routes  : mixed
If empty, all audio captured in both channels.

Methods

__construct()  : mixed
Constructor.
getRoutes()  : RepeatedField<string|int, AudioRoute>
If empty, all audio captured in both channels.
setRoutes()  : $this
If empty, all audio captured in both channels.

Properties

$routes

If empty, all audio captured in both channels.

private mixed $routes

If non-empty, only matching audio is captured and routed. Unmatched is excluded.

Generated from protobuf field repeated .livekit.AudioRoute routes = 1;

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 \Livekit\AudioRoute[] $routes
      If empty, all audio captured in both channels.
      If non-empty, only matching audio is captured and routed. Unmatched is excluded.

}

getRoutes()

If empty, all audio captured in both channels.

public getRoutes() : RepeatedField<string|int, AudioRoute>

If non-empty, only matching audio is captured and routed. Unmatched is excluded.

Generated from protobuf field repeated .livekit.AudioRoute routes = 1;

Return values
RepeatedField<string|int, AudioRoute>

setRoutes()

If empty, all audio captured in both channels.

public setRoutes(array<string|int, AudioRoute$var) : $this

If non-empty, only matching audio is captured and routed. Unmatched is excluded.

Generated from protobuf field repeated .livekit.AudioRoute routes = 1;

Parameters
$var : array<string|int, AudioRoute>
Return values
$this

        
On this page

Search results