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 destination in the media processing pipeline.
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 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:
sourceIdproperty, if the track is created by calling
Gets the visibility of the
<video> HTML tag.
After you call
localVideoTrack.play, the SDK creates an
<video> tag for playing video tracks. When
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:
<video>tag does not exist.
<video>tag is not created by calling the
Removes the listener for a specified event.
The event name.
The callback that corresponds to the event listener.
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 an extension into the media processing pipeline in the SDK.
The instance of the media processor.
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.
Enables/Disables image enhancement and sets the options.
- Agora is planning to sunset this built-in image enhancement feature. You can use the upgraded Image Enhancement Extension instead. For details, see Use the Image Enhancement Extension.
- This method supports the following browsers:
- Safari 12 or later.
- Chrome 65 or later.
- Firefox 70.0.1 or later.
- This function is not supported on mobile devices.
- If you enable dual-stream mode, the image enhancement options only apply to the high-quality video stream.
Whether to enable image enhancement:
true: Enable image enhancement.
false: Disable image enhancement.
Sets image enhancement options. See BeautyEffectOptions.
Sets the device for capturing video.
You can call this method either before or after publishing the video track.
The ID of the specified device. You can get the
deviceId by calling AgoraRTC.getCameras.
Enables/Disables the track.
After a track is disabled, the SDK stops playing and publishing the track.
Whether to enable the track:
true: Enable the track.
false: Disable the track.
Sends or stops sending the media data of the track.
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
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.
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
"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.
Removes extensions from the media processing pipeline.