io.agora.rtc.AgoraLocalVideoTrack Class Reference

Public Member Functions
	AgoraLocalVideoTrack (long cptr)
void	destroy ()
native void	setEnabled (int enable)
native int	setVideoEncoderConfig (VideoEncoderConfig config)
native int	enableSimulcastStream (int enabled, SimulcastStreamConfig config)
native int	getState ()
native LocalVideoTrackStats	getStatistics ()

Constructor & Destructor Documentation

AgoraLocalVideoTrack()

io.agora.rtc.AgoraLocalVideoTrack.AgoraLocalVideoTrack

(

long

cptr

)

Constructor.

Member Function Documentation

destroy()

void io.agora.rtc.AgoraLocalVideoTrack.destroy

(

)

Destructor.

enableSimulcastStream()

native int io.agora.rtc.AgoraLocalVideoTrack.enableSimulcastStream	(	int	enabled,
		SimulcastStreamConfig	config
	)

Enables or disables the simulcast stream mode.

Parameters

enabled	Determines whether to enable or disable the simulcast stream mode. true: Enable the simulcast stream mode. false: Disable the simulcast stream mode.
config	The reference to the configurations for the simulcast stream mode.

Returns

• 0: Success.
• < 0: Failure.

getState()

native int io.agora.rtc.AgoraLocalVideoTrack.getState

(

)

Gets the state of the local video stream.

Returns

The current state of the local video stream.

getStatistics()

native LocalVideoTrackStats io.agora.rtc.AgoraLocalVideoTrack.getStatistics

(

)

Gets the statistics of the local video track.

Returns

The statistics of the local video track.

setEnabled()

native void io.agora.rtc.AgoraLocalVideoTrack.setEnabled

(

int

enable

)

Enables or disables the local video track.

Once the local video track is enabled, the SDK allows for local video capturing, processing, and encoding.

Parameters

enable

Determines whether to enable the local video track. true: Enable the local video track. false: Disable the local video track.

setVideoEncoderConfig()

native int io.agora.rtc.AgoraLocalVideoTrack.setVideoEncoderConfig

(

VideoEncoderConfig

config

)

Sets the video encoder configuration.

Each video encoder configuration corresponds to a set of video parameters, including the resolution, frame rate, bitrate, and video orientation.

The configurations specified in this method are the maximum values under ideal network conditions. If the video engine cannot render the video using the specified parameters due to poor network conditions, the configurations further down the list are considered until a successful configuration is found.

Parameters

config

The reference to the video encoder configuration.

Returns

• 0: Success.
• < 0: Failure.

---

The documentation for this class was generated from the following file:

• AgoraLocalVideoTrack.java