Interface ILocalVideoTrack

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.

Hierarchy

Index

Events

beauty-effect-overload

  • beauty-effect-overload(): void
  • Occurs when the device is overloaded after you call 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);
    });

    Returns void

Properties

isPlaying

isPlaying: boolean

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.

trackMediaType

trackMediaType: "audio" | "video"

The type of a media track:

  • "audio": Audio track.
  • "video": Video track.

Methods

close

  • close(): void
  • 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

  • getCurrentFrameData(): ImageData
  • 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.

    Returns ImageData

    An ImageData object that stores RGBA data. ImageData is a web API supported by the browser. For details, see ImageData.

getListeners

  • getListeners(event: string): Function[]
  • Gets all the listeners for a specified event.

    Parameters

    • event: string

      The event name.

    Returns Function[]

getMediaStreamTrack

  • getMediaStreamTrack(): MediaStreamTrack

getStats

getTrackId

  • getTrackId(): string
  • Gets the ID of a media track, a unique identifier generated by the SDK.

    Returns string

    The media track ID.

getTrackLabel

  • getTrackLabel(): string
  • 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 createMicrophoneAudioTrack or createCameraVideoTrack.
    • The sourceId property, if the track is created by calling createScreenVideoTrack.
    • The MediaStreamTrack.label property, if the track is created by calling createCustomAudioTrack or createCustomVideoTrack.

off

  • off(event: string, listener: Function): void
  • 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

once

  • once(event: string, listener: Function): void
  • 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

  • removeAllListeners(event?: undefined | string): void
  • 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.

    Parameters

    • enabled: boolean

      Sets 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>

setEnabled

  • setEnabled(enabled: boolean): Promise<void>
  • Since
       4.0.0

    Enables/Disables the track.

    After a track is disabled, the SDK stops playing and publishing the track.

    Parameters

    • enabled: boolean

      Whether to enable the track:

      • true: Enable the track.
      • false: Disable the track.

    Returns Promise<void>

setOptimizationMode

  • setOptimizationMode(mode: "balanced" | "motion" | "detail"): Promise<void>
  • 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.

    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

  • stop(): void
  • Stops playing the media track.

    Returns void