SEI data in Uint8Array
The visibility of the <video>
tag.
Whether a media track is playing on the webpage:
true
: The media track is playing on the webpage.false
: The media track is not playing on the webpage.The type of a media track:
"audio"
: Audio track."video"
: Video track.The encoding configuration for the new video track. You can pass in the SDK's built-in encoding configuration through VideoEncoderConfiguration, or customize the video encoding configuration by passing in a VideoEncoderConfigurationPreset.
Whether to clone the current track. Default is true
.
The newly generated video track.
Closes a local track and releases the audio and video resources that it occupies.
Once you close a local track, you can no longer reuse it.
An ImageData
object that stores RGBA data. ImageData
is a web API supported by the browser. For details, see ImageData.
Gets all the listeners for a specified event.
The event name.
Gets an MediaStreamTrack object.
An MediaStreamTrack object.
Gets the RTCRtpTransceiver instance of the current track.
This method is currently mainly used for end-to-end encryption of video streams (Beta).
If the SDK experiences a reconnection, the
RTCRtpTransceiver
instance corresponding to the current track might change. You can obtain the newRTCRtpTransceiver
instance through the following callbacks:
- For a local track: ILocalTrack.transceiver-updated
- For a remote track: IRemoteTrack.transceiver-updated
The type of the video stream. See StreamType.
The RTCRtpTransceiver instance of the current track.
Gets the statistics of a local video track.
Gets the ID of a media track, a unique identifier generated by the SDK.
The media track ID.
Gets the label of a local track.
The label that the SDK returns may include:
createMicrophoneAudioTrack
or createCameraVideoTrack
.sourceId
property, if the track is created by calling createScreenVideoTrack
.createCustomAudioTrack
or createCustomVideoTrack
.The CheckVideoVisibleResult object. If this method returns undefined
, it may be due to the following reasons:
localVideoTrack.isPlaying
is false
.<video>
tag does not exist.<video>
tag is not created by calling the play
method.Removes the listener for a specified event.
The event name.
The callback that corresponds to the event listener.
The event name.
See track-ended.
The event name.
Adds an event listener.
The event name.
Listens for a specified event once.
When the specified event happens, the SDK triggers the callback that you pass and then removes the listener.
The event name.
The callback to trigger.
Inserts a Processor
to the local video track.
The Processor
instance. Each extension has a corresponding type of Processor
.
The Processor
instance.
Plays a remote video track on the web page.
Specifies a DOM element. The SDK will create a <video>
element under the specified DOM element to play the video track. You can specify a DOM element in either of the following ways:
string
: Specify the ID of the DOM element.HTMLElement
: Pass a DOM object.Sets the playback configurations, such as display mode and mirror mode. See VideoPlayerConfig. By default, the SDK enables mirror mode for a local video track.
Removes all listeners for a specified event.
The event name. If left empty, all listeners for all events are removed.
The new video track, which is a MediaStreamTrack object.
Whether to stop the old video track:
Add the SEI data to the H.264 video stream.
Whether to enable the track:
true
: Enable the track.false
: Disable the track.Sets the video encoder configurations, such as resolution, frame rate, and bitrate.
The video encoder configurations. You can pass either VideoEncoderConfigurationPreset or a customized VideoEncoderConfiguration object.
Sends or stops sending the media data of the track.
Whether to stop sending the media data of the track:
true
: Stop sending the media data of the track.false
: Resume sending the media data of the track.The video transmission optimization mode:
"balanced"
: Uses the default optimization mode."detail"
: Prioritizes video quality."motion"
: Prioritizes video smoothness.Stops playing the media track.
LocalVideoTrack
is the basic interface for local video tracks, providing the main methods for local video tracks.You can get create a local video track by calling AgoraRTC.createCustomVideoTrack or AgoraRTC.createScreenVideoTrack method.
Inherited from
LocalVideoTrack
, CameraVideoTrack is an interface for the video captured by a local camera and adds several camera-related functions.