MediaSource
extends Message
in package
Capture tracks directly from a room via SDK.
Unifies deprecated Participant, TrackComposite, and Track egress.
Generated from protobuf message livekit.MediaSource
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructor.
- clearAudio() : mixed
- getAudio() : AudioConfig|null
- TODO: DataConfig data = 4;
- getParticipantVideo() : ParticipantVideo|null
- Generated from protobuf field <code>.livekit.ParticipantVideo participant_video = 2;</code>
- getVideo() : string
- getVideoTrackId() : string
- Generated from protobuf field <code>string video_track_id = 1 [(.logger.name) = "videoTrackID"];</code>
- hasAudio() : mixed
- hasParticipantVideo() : mixed
- hasVideoTrackId() : mixed
- setAudio() : $this
- TODO: DataConfig data = 4;
- setParticipantVideo() : $this
- Generated from protobuf field <code>.livekit.ParticipantVideo participant_video = 2;</code>
- setVideoTrackId() : $this
- Generated from protobuf field <code>string video_track_id = 1 [(.logger.name) = "videoTrackID"];</code>
Properties
$audio
TODO: DataConfig data = 4;
protected
mixed
$audio
= null
Generated from protobuf field .livekit.AudioConfig audio = 3;
$video
protected
mixed
$video
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 string $video_track_id @type \Livekit\ParticipantVideo $participant_video @type \Livekit\AudioConfig $audio TODO: DataConfig data = 4;}
clearAudio()
public
clearAudio() : mixed
getAudio()
TODO: DataConfig data = 4;
public
getAudio() : AudioConfig|null
Generated from protobuf field .livekit.AudioConfig audio = 3;
Return values
AudioConfig|nullgetParticipantVideo()
Generated from protobuf field <code>.livekit.ParticipantVideo participant_video = 2;</code>
public
getParticipantVideo() : ParticipantVideo|null
Return values
ParticipantVideo|nullgetVideo()
public
getVideo() : string
Return values
stringgetVideoTrackId()
Generated from protobuf field <code>string video_track_id = 1 [(.logger.name) = "videoTrackID"];</code>
public
getVideoTrackId() : string
Return values
stringhasAudio()
public
hasAudio() : mixed
hasParticipantVideo()
public
hasParticipantVideo() : mixed
hasVideoTrackId()
public
hasVideoTrackId() : mixed
setAudio()
TODO: DataConfig data = 4;
public
setAudio(AudioConfig $var) : $this
Generated from protobuf field .livekit.AudioConfig audio = 3;
Parameters
- $var : AudioConfig
Return values
$thissetParticipantVideo()
Generated from protobuf field <code>.livekit.ParticipantVideo participant_video = 2;</code>
public
setParticipantVideo(ParticipantVideo $var) : $this
Parameters
- $var : ParticipantVideo
Return values
$thissetVideoTrackId()
Generated from protobuf field <code>string video_track_id = 1 [(.logger.name) = "videoTrackID"];</code>
public
setVideoTrackId(string $var) : $this
Parameters
- $var : string