com.twilio.video

Class LocalVideoTrack

java.lang.Object

com.twilio.video.VideoTrack

com.twilio.video.LocalVideoTrack

All Implemented Interfaces:

Track

public class LocalVideoTrack
extends VideoTrack

A local video track that gets video frames from a specified VideoCapturer.

Method Summary

Modifier and Type	Method and Description
void	addRenderer(VideoRenderer videoRenderer) Add a video renderer to get video from the video track.
static LocalVideoTrack	create(android.content.Context context, boolean enabled, VideoCapturer videoCapturer) Creates a local video track.
static LocalVideoTrack	create(android.content.Context context, boolean enabled, VideoCapturer videoCapturer, String name) Creates a local video track.
static LocalVideoTrack	create(android.content.Context context, boolean enabled, VideoCapturer videoCapturer, VideoConstraints videoConstraints) Creates a local video track.
static LocalVideoTrack	create(android.content.Context context, boolean enabled, VideoCapturer videoCapturer, VideoConstraints videoConstraints, String name) Creates a local video track.
void	enable(boolean enabled) Sets the state of the local video track.
String	getName() Returns the local video track name.
VideoCapturer	getVideoCapturer() Retrieves the VideoCapturer associated with this video track.
VideoConstraints	getVideoConstraints() Retrieves the video constraints associated with this track.
boolean	isEnabled() Check if the local video track is enabled.
void	release() Releases native memory owned by video track.
void	removeRenderer(VideoRenderer videoRenderer) Remove a video renderer to stop receiving video from the video track.

Methods inherited from class com.twilio.video.VideoTrack

getRenderers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static LocalVideoTrack create(android.content.Context context,
                                     boolean enabled,
                                     VideoCapturer videoCapturer)

Creates a local video track. Local video track invokes VideoCapturer.getSupportedFormats() to find the closest supported VideoFormat to 640x480 at 30 frames per second. The closest format is used to apply default VideoConstraints to the returned LocalVideoTrack.

Parameters:

context - application context.

enabled - initial state of video track.

videoCapturer - capturer that provides video frames.

Returns:

local video track if successfully added or null if video track could not be created.

create

public static LocalVideoTrack create(android.content.Context context,
                                     boolean enabled,
                                     VideoCapturer videoCapturer,
                                     VideoConstraints videoConstraints)

Creates a local video track. Local video track will only apply videoConstraints compatible with videoCapturer. Default constraints described in create(Context, boolean, VideoCapturer) will be applied to the returned LocalVideoTrack for the following conditions:

1. Passing null as videoConstraints.
2. videoConstraints are incompatible with videoCapturer

Video constraints are incompatible with a capturer if there is not at least one supported VideoFormat for which all the following conditions true:

1. VideoConstraints.minFps and VideoConstraints.maxFps are both less than or equal supported capture format frame rate.
2. VideoConstraints.minVideoDimensions width and height are less than or equal to a supported capture format width and height.
3. VideoConstraints.maxVideoDimensions width and height are greater than or equal to a supported capture format width and height.

Parameters:

context - application context.

enabled - initial state of video track.

videoCapturer - capturer that provides video frames.

videoConstraints - constraints to be applied on video track.

Returns:

local video track if successfully added or null if video track could not be created.

create

public static LocalVideoTrack create(android.content.Context context,
                                     boolean enabled,
                                     VideoCapturer videoCapturer,
                                     String name)

Creates a local video track. Local video track invokes VideoCapturer.getSupportedFormats() to find the closest supported VideoFormat to 640x480 at 30 frames per second. The closest format is used to apply default VideoConstraints to the returned LocalVideoTrack.

Parameters:

context - application context.

enabled - initial state of video track.

videoCapturer - capturer that provides video frames.

name - video track name.

Returns:

local video track if successfully added or null if video track could not be created.

create

public static LocalVideoTrack create(android.content.Context context,
                                     boolean enabled,
                                     VideoCapturer videoCapturer,
                                     VideoConstraints videoConstraints,
                                     String name)

Creates a local video track. Local video track will only apply videoConstraints compatible with videoCapturer. Default constraints described in create(Context, boolean, VideoCapturer) will be applied to the returned LocalVideoTrack for the following conditions:

1. Passing null as videoConstraints.
2. videoConstraints are incompatible with videoCapturer

Video constraints are incompatible with a capturer if there is not at least one supported VideoFormat for which all the following conditions true:

1. VideoConstraints.minFps and VideoConstraints.maxFps are both less than or equal supported capture format frame rate.
2. VideoConstraints.minVideoDimensions width and height are less than or equal to a supported capture format width and height.
3. VideoConstraints.maxVideoDimensions width and height are greater than or equal to a supported capture format width and height.

Parameters:

context - application context.

enabled - initial state of video track.

videoCapturer - capturer that provides video frames.

name - video track name.

Returns:

local video track if successfully added or null if video track could not be created.

getVideoCapturer

public VideoCapturer getVideoCapturer()

Retrieves the VideoCapturer associated with this video track.

getVideoConstraints

public VideoConstraints getVideoConstraints()

Retrieves the video constraints associated with this track.

If you do not provide any video constraints, the default video constraints are set to a maximum video dimension size of 640x480 at a frame rate of 30 frames per second.

addRenderer

public void addRenderer(VideoRenderer videoRenderer)

Description copied from class: VideoTrack

Add a video renderer to get video from the video track.

Overrides:

addRenderer in class VideoTrack

Parameters:

videoRenderer - video renderer that receives video.

removeRenderer

public void removeRenderer(VideoRenderer videoRenderer)

Description copied from class: VideoTrack

Remove a video renderer to stop receiving video from the video track.

Overrides:

removeRenderer in class VideoTrack

Parameters:

videoRenderer - the video renderer that should no longer receives video.

isEnabled

public boolean isEnabled()

Check if the local video track is enabled.

When the value is false, blank video frames are sent. When the value is true, frames from the video capturer are provided.

Specified by:

isEnabled in interface Track

Overrides:

isEnabled in class VideoTrack

Returns:

true if the local video is enabled.

getName

public String getName()

Returns the local video track name. A pseudo random string is returned if no track name was specified.

Specified by:

getName in interface Track

Overrides:

getName in class VideoTrack

enable

public void enable(boolean enabled)

Sets the state of the local video track. The results of this operation are signaled to other Participants in the same Room. When a video track is disabled, blank frames are sent in place of video frames from a video capturer.

Parameters:

enabled - the desired state of the local video track.

release

public void release()

Releases native memory owned by video track.