Hierarchy
-
ILocalVideoTrack
- ICameraVideoTrack
Index
Properties
enabled
isPlaying
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.
muted
trackMediaType
The type of a media track:
"audio": Audio track."video": Video track.
Methods
close
-
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.
Returns void
getCurrentFrameData
getListeners
-
Gets all the listeners for a specified event.
Parameters
-
event: string
The event name.
Returns Function[]
-
getMediaStreamTrack
-
Gets an MediaStreamTrack object.
Returns MediaStreamTrack
An MediaStreamTrack object.
getStats
-
Gets the statistics of a local video track.
DEPRECATED from v4.1.0. Use AgoraRTCClient.getLocalVideoStats and AgoraRTCClient.getLocalAudioStats instead.
Returns LocalVideoTrackStats
getTrackId
-
Gets the ID of a media track, a unique identifier generated by the SDK.
Returns string
The media track ID.
getTrackLabel
-
Gets the label of a local track.
Returns string
The label that the SDK returns may include:
- The MediaDeviceInfo.label property, if the track is created by calling
createMicrophoneAudioTrackorcreateCameraVideoTrack. - The
sourceIdproperty, if the track is created by callingcreateScreenVideoTrack. - The MediaStreamTrack.label property, if the track is created by calling
createCustomAudioTrackorcreateCustomVideoTrack.
- The MediaDeviceInfo.label property, if the track is created by calling
off
-
Removes the listener for a specified event.
Parameters
-
event: string
The event name.
-
listener: Function
The callback that corresponds to the event listener.
Returns void
-
on
-
Parameters
-
event: "beauty-effect-overload"
-
listener: event_beauty_effect_overload
Returns void
-
-
Parameters
-
event: "track-ended"
-
listener: event_track_ended
Returns void
-
once
-
Listens for a specified event once.
When the specified event happens, the SDK triggers the callback that you pass and then removes the listener.
Parameters
-
event: string
The event name.
-
listener: Function
The callback to trigger.
Returns void
-
play
-
Plays a local video track on the web page.
Parameters
-
element: string | HTMLElement
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: VideoPlayerConfig
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.
Returns void
-
removeAllListeners
-
Removes all listeners for a specified event.
Parameters
-
Optional event: undefined | string
The event name. If left empty, all listeners for all events are removed.
Returns void
-
setBeautyEffect
-
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.
Parameters
-
enabled: boolean
Whether to enable image enhancement:
true: Enable image enhancement.false: Disable image enhancement.
-
Optional options: BeautyEffectOptions
Sets image enhancement options. See BeautyEffectOptions.
Returns Promise<void>
- This method supports the following browsers:
setDevice
-
Sets the device for capturing video.
You can call this method either before or after publishing the video track.
Parameters
-
deviceId: string
The ID of the specified device. You can get the
deviceIdby calling AgoraRTC.getCameras.
Returns Promise<void>
-
setEnabled
-
Since
4.0.0Enables/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
setEnabledandsetMutedtogether.
Parameters
-
enabled: boolean
Whether to enable the track:
true: Enable the track.false: Disable the track.
Returns Promise<void>
setEncoderConfiguration
-
Sets the video encoder configurations, such as resolution, frame rate, and bitrate.
Note: This method is not supported on mobile devices.
Parameters
-
config: VideoEncoderConfiguration | VideoEncoderConfigurationPreset
The video encoder configurations. You can pass either VideoEncoderConfigurationPreset or a customized VideoEncoderConfiguration object.
Returns Promise<void>
-
setMuted
-
Sends or stops sending the media data of the track.
Since
4.6.0If the track is published, a successful call of
setMuted(true)triggers the user-unpublished event on the remote client, and a successful call ofsetMuted(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
setEnabledandsetMutedtogether.
Parameters
-
muted: boolean
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.
Returns Promise<void>
- Calling
setOptimizationMode
-
Since
4.2.0Sets 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.
Parameters
-
mode: "balanced" | "motion" | "detail"
The video transmission optimization mode:
"balanced": Uses the default optimization mode.- For a screen-sharing video track, the default transmission optimization strategy is to prioritizes clarity.
- For the other types of video tracks, the SDK may reduce the frame rate or the sending resolution in poor network conditions.
"detail": Prioritizes video quality.- The SDK ensures high-quality images by automatically calculating a minimum bitrate based on the capturing resolution and frame rate. No matter how poor the network condition is, the sending bitrate will never be lower than the minimum value.
- In most cases, the SDK does not reduce the sending resolution, but may reduce the frame rate.
"motion": Prioritizes video smoothness.- In poor network conditions, the SDK reduces the sending bitrate to minimize video freezes.
- In most cases, the SDK does not reduce the frame rate, but may reduce the sending resolution.
Returns Promise<void>
-
stop
-
Stops playing the media track.
Returns void
Inherited from LocalVideoTrack,
CameraVideoTrackis an interface for the video captured by a local camera and adds functions such as switching devices and adjusting video encoder configurations.You can create a local camera video track by calling AgoraRTC.createCameraVideoTrack.