Documentation

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

$audio  : mixed
Generated from protobuf field <code>.livekit.AudioConfig audio = 3;</code>
$data  : mixed
Generated from protobuf field <code>.livekit.DataConfig data = 4;</code>
$video  : mixed

Methods

__construct()  : mixed
Constructor.
clearAudio()  : mixed
clearData()  : mixed
getAudio()  : AudioConfig|null
Generated from protobuf field <code>.livekit.AudioConfig audio = 3;</code>
getData()  : DataConfig|null
Generated from protobuf field <code>.livekit.DataConfig data = 4;</code>
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
hasData()  : mixed
hasParticipantVideo()  : mixed
hasVideoTrackId()  : mixed
setAudio()  : $this
Generated from protobuf field <code>.livekit.AudioConfig audio = 3;</code>
setData()  : $this
Generated from protobuf field <code>.livekit.DataConfig data = 4;</code>
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

Generated from protobuf field <code>.livekit.AudioConfig audio = 3;</code>

protected mixed $audio = null

$data

Generated from protobuf field <code>.livekit.DataConfig data = 4;</code>

protected mixed $data = null

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
@type \Livekit\DataConfig $data

}

getVideo()

public getVideo() : string
Return values
string

getVideoTrackId()

Generated from protobuf field <code>string video_track_id = 1 [(.logger.name) = "videoTrackID"];</code>

public getVideoTrackId() : string
Return values
string

hasParticipantVideo()

public hasParticipantVideo() : mixed

setAudio()

Generated from protobuf field <code>.livekit.AudioConfig audio = 3;</code>

public setAudio(AudioConfig $var) : $this
Parameters
$var : AudioConfig
Return values
$this

setData()

Generated from protobuf field <code>.livekit.DataConfig data = 4;</code>

public setData(DataConfig $var) : $this
Parameters
$var : DataConfig
Return values
$this

setParticipantVideo()

Generated from protobuf field <code>.livekit.ParticipantVideo participant_video = 2;</code>

public setParticipantVideo(ParticipantVideo $var) : $this
Parameters
$var : ParticipantVideo
Return values
$this

setVideoTrackId()

Generated from protobuf field <code>string video_track_id = 1 [(.logger.name) = "videoTrackID"];</code>

public setVideoTrackId(string $var) : $this
Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results