Since
4.8.0
Indicates the visibility of the <video>
HTML tag.
The SDK triggers this event every 30 seconds.
After you call localVideoTrack.play
, the SDK creates an <video>
tag for playing video tracks. When localVideoTrack.isPlaying
is true
but you cannot see any video, this event helps you check whether the <video>
tag is visible or not and learn the reason when the <video>
tag is invisible.
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.Since
4.10.0
The destination of the current processing pipeline on the local video track.
The type of a media track:
"audio"
: Audio track."video"
: 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.
Gets all the listeners for a specified event.
The event name.
Gets an MediaStreamTrack object.
An MediaStreamTrack object.
Gets the statistics of a local video track.
DEPRECATED from v4.1.0. Use AgoraRTCClient.getLocalVideoStats and AgoraRTCClient.getLocalAudioStats instead.
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
.Since
4.8.0
Gets the visibility of the <video>
HTML tag.
After you call localVideoTrack.play
, the SDK creates an <video>
tag for playing video tracks. When localVideoTrack.isPlaying
is true
but you cannot see any video, call this method to check whether the <video>
tag is visible or not and learn the reason when the <video>
tag is invisible.
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.
See event_track_ended for details.
See event_video_element_visible_status for details.
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 local 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.
Since
4.17.0
Replaces the local video track.
You can call this method before or after publishing the local video stream:
The new video track can be retrieved by the ILocalVideoTrack.getMediaStreamTrack or mediaStream.getVideoTracks
method. You can choose to either stop or retain the replaced track.
Notes:
- This method supports Chrome 65+, Safari, and the latest Firefox.
- This method might not take effect on some mobile devices.
- Agora recommends switching between video tracks that are of the same type and have the same encoder configurations for the following reasons:
- If the video track types are different, such as replacing a
CameraVideoTrack
object with aScreenVideoTrack
object, the video is flipped horizontally due to the mirror effect enabled by default onCameraVideoTrack
(see VideoPlayerConfig.mirror for details).- If the encoder configurations (
encoderConfig
) are different, the actual sending resolution or frame rate might be different from what you set.- The subscriber will not be notified if the track gets replaced.
- To switch the media input devices, Agora recommends using ICameraVideoTrack.setDevice.
Example
// Current video track
const localVideoTrack = await AgoraRTC.createCameraVideoTrack();
// Gets the new video track (option one)
const newTrack = localVideoTrack.getMediaStreamTrack();
// Gets the new video track (option two)
const newTrack = await navigator.mediaDevices.getUserMedia({audio: true, video: true}).then(mediaStream => mediaStream.getVideoTracks()[0]);
// Replaces and stops the current video track
await localVideoTrack.replaceTrack(newTrack, true);
The new video track, which is a MediaStreamTrack object.
Whether to stop the old video track:
Since
4.0.0
Enables/Disables the track.
After a track is disabled, the SDK stops playing and publishing the track.
- Disabling a track does not trigger the LocalTrack.on("track-ended") event.
- If a track is published, disabling this track triggers the user-unpublished event on the remote client, and re-enabling this track triggers the user-published event.
- Do not call
setEnabled
andsetMuted
together.
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.
Since
4.6.0
If the track is published, a successful call of setMuted(true)
triggers the user-unpublished event on the remote client, and a successful call of setMuted(false)
triggers the user-published event.
- Calling
setMuted(true)
does not stop capturing audio or video and takes shorter time to take effect than setEnabled. For details, see What are the differences between setEnabled and setMuted?.- Do not call
setEnabled
andsetMuted
together.
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.Since
4.2.0
Sets the video transmission optimization mode.
You can call this method during a video call, a live streaming or screen sharing to dynamically change the optimization mode. For example, during the screen sharing, before you change the shared content from text to video, you can change the optimization mode from "detail"
to "motion"
to ensure smoothness in poor network conditions.
Note: This method supports Chrome only.
The video transmission optimization mode:
"balanced"
: Uses the default optimization mode."detail"
: Prioritizes video quality."motion"
: Prioritizes video smoothness.Stops playing the media track.
Since
4.10.0
Removes the Processor
inserted to the local video 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.