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.Since
4.1.0
Gets the data of the video frame being rendered.
You should call this method after calling play. Otherwise, the method call returns null.
An ImageData object that stores RGBA data. ImageData is a web API supported by the browser. For details, see ImageData.
Gets the statistics of a local video track.
DEPRECATED from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]getLocalVideoStats and [AgoraRTCClient.getLocalAudioStats]getLocalAudioStats instead.
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.Listens for a specified event.
When the specified event happens, the SDK triggers the callback that you pass.
The event name.
The callback to trigger.
Occurs when the device is overloaded after you call [setBeautyEffect]setBeautyEffect to enable image enhancement.
You can listen for this event to notify users of the device overload and disable image enhancement.
localVideoTrack.on("beauty-effect-overload", () => {
console.log("beauty effect overload, disable beauty effect");
localVideoTrack.setBeautyEffect(false);
});
ILocalVideoTrack
Events
Occurs when a audio or video track ends.
Reasons may include:
ILocalTrack
Events
Optional data: CheckVisibleResultPlays 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.Optional config: VideoPlayerConfigSets the playback configurations, such as display mode and mirror mode. See VideoPlayerConfig. By default, the SDK enables mirror mode for a local video track.
Enables/Disables image enhancement and sets the options.
Notes:
- 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.Optional options: BeautyEffectOptionsSets image enhancement options. See BeautyEffectOptions.
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_track_ended event.
- If a track is published, disabling this track triggers the [user-unpublished]IAgoraRTCClient.event_user_unpublished event on the remote client, and re-enabling this track triggers the [user-published]IAgoraRTCClient.event_user_published event.
Whether to enable the track:
true: Enable the track.false: Disable the track.Sends or stops sending the media data of the track.
Since
4.6.0
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?.
If the track is published, a successful call of setMuted(true) triggers the [user-unpublished]IAgoraRTCClient.event_user_unpublished event on the remote client, and a successful call of setMuted(false) triggers the [user-published]IAgoraRTCClient.event_user_published event.
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.Generated using TypeDoc
LocalVideoTrackis 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]IAgoraRTC.createCustomVideoTrack or [AgoraRTC.createScreenVideoTrack]IAgoraRTC.createScreenVideoTrack method.
Inherited from
LocalVideoTrack, [CameraVideoTrack]ICameraVideoTrack is an interface for the video captured by a local camera and adds several camera-related functions.