com.twilio.video

Class LocalParticipant

java.lang.Object

com.twilio.video.LocalParticipant

All Implemented Interfaces:

Participant

public class LocalParticipant
extends Object
implements Participant

Represents the local participant of a Room you are connected to.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LocalParticipant.Listener Interface that provides LocalParticipant events.

Method Summary

Modifier and Type	Method and Description
List<AudioTrackPublication>	getAudioTracks() Returns read-only list of audio track publications.
List<DataTrackPublication>	getDataTracks() Returns read-only list of data track publications.
String	getIdentity() Returns the identity of the local participant.
List<LocalAudioTrackPublication>	getLocalAudioTracks() Returns read-only list of local audio track publications.
List<LocalDataTrackPublication>	getLocalDataTracks() Returns read-only list of local data track publications.
List<LocalVideoTrackPublication>	getLocalVideoTracks() Returns read-only list of local video track publications.
NetworkQualityLevel	getNetworkQualityLevel() Returns the network quality of the local participant.
String	getSid() Returns the SID of the local participant.
String	getSignalingRegion() Where the LocalParticipant's signaling traffic enters and exits Twilio's communications cloud.
List<VideoTrackPublication>	getVideoTracks() Returns read-only list of video track publications.
boolean	publishTrack(LocalAudioTrack localAudioTrack) Shares audio track to all participants in a Room.
boolean	publishTrack(LocalDataTrack localDataTrack) Shared data track to all participants in a Room.
boolean	publishTrack(LocalVideoTrack localVideoTrack) Shares video track to all participants in a Room.
void	setEncodingParameters(EncodingParameters encodingParameters) Updates the EncodingParameters used to share media in the Room.
void	setListener(LocalParticipant.Listener listener) Set listener for local participant events.
boolean	unpublishTrack(LocalAudioTrack localAudioTrack) Stops the sharing of an audio track to all the participants in a Room.
boolean	unpublishTrack(LocalDataTrack localDataTrack) Stops the sharing of a data track to all the participants in a Room.
boolean	unpublishTrack(LocalVideoTrack localVideoTrack) Stops the sharing of a video track to all the participants in a Room.

Methods inherited from class java.lang.Object

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

Method Detail

getSid

public String getSid()

Returns the SID of the local participant.

Specified by:

getSid in interface Participant

getIdentity

public String getIdentity()

Returns the identity of the local participant.

Specified by:

getIdentity in interface Participant

getSignalingRegion

public String getSignalingRegion()

Where the LocalParticipant's signaling traffic enters and exits Twilio's communications cloud. This property reflects the region passed to ConnectOptions.Builder.region(String) and when `gll` (the default value) is provided, the region that was selected using latency based routing.

getNetworkQualityLevel

public NetworkQualityLevel getNetworkQualityLevel()

Returns the network quality of the local participant.

getAudioTracks

public List<AudioTrackPublication> getAudioTracks()

Returns read-only list of audio track publications.

Specified by:

getAudioTracks in interface Participant

getVideoTracks

public List<VideoTrackPublication> getVideoTracks()

Returns read-only list of video track publications.

Specified by:

getVideoTracks in interface Participant

getDataTracks

public List<DataTrackPublication> getDataTracks()

Returns read-only list of data track publications.

Specified by:

getDataTracks in interface Participant

getLocalAudioTracks

public List<LocalAudioTrackPublication> getLocalAudioTracks()

Returns read-only list of local audio track publications.

getLocalVideoTracks

public List<LocalVideoTrackPublication> getLocalVideoTracks()

Returns read-only list of local video track publications.

getLocalDataTracks

public List<LocalDataTrackPublication> getLocalDataTracks()

Returns read-only list of local data track publications.

publishTrack

public boolean publishTrack(LocalAudioTrack localAudioTrack)

Shares audio track to all participants in a Room.

Returns:

true if the audio track published or false if the local participant is not connected or the track was already published.

publishTrack

public boolean publishTrack(LocalVideoTrack localVideoTrack)

Shares video track to all participants in a Room.

Returns:

true if the video track was published or false if the local participant is not connected or the track was already published.

publishTrack

public boolean publishTrack(LocalDataTrack localDataTrack)

Shared data track to all participants in a Room.

Returns:

true if the data track was published or false if the local participant is not connected or the track was already published.

unpublishTrack

public boolean unpublishTrack(LocalAudioTrack localAudioTrack)

Stops the sharing of an audio track to all the participants in a Room.

Returns:

true if the audio track was unpublished or false if the local participant is not connected or could not unpublish audio track.

unpublishTrack

public boolean unpublishTrack(LocalVideoTrack localVideoTrack)

Stops the sharing of a video track to all the participants in a Room.

Returns:

true if video track was unpublished or false if the local participant is not connected or could not unpublish video track.

unpublishTrack

public boolean unpublishTrack(LocalDataTrack localDataTrack)

Stops the sharing of a data track to all the participants in a Room.

Returns:

true if the data track was unpublished or false if the local participant is not connected or could not unpublish the data track.

setListener

public void setListener(LocalParticipant.Listener listener)

Set listener for local participant events.

Parameters:

listener - of local participant events.

setEncodingParameters

public void setEncodingParameters(EncodingParameters encodingParameters)

Updates the EncodingParameters used to share media in the Room.

Parameters:

encodingParameters - The EncodingParameters to use or null for the default values.