com.ciscowebex.androidsdk.phone

Class MediaOption

java.lang.Object

com.ciscowebex.androidsdk.phone.MediaOption

public class MediaOption
extends java.lang.Object

A data type represents the media options of a call.

Since:

0.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaOption.CompositedVideoLayout The video layout for the active speaker and other attendees in the group video meeting.
static class	MediaOption.VideoLayout Deprecated. please use MediaOption.CompositedVideoLayout

Method Summary

Modifier and Type	Method and Description
static MediaOption	audioOnly() Constructs an audio only media option.
static MediaOption	audioVideo(android.util.Pair<android.view.View,android.view.View> videoRenderViews) Constructs an audio and video media option.
static MediaOption	audioVideo(android.view.View localView, android.view.View remoteView) Constructs an audio and video media option.
static MediaOption	audioVideoSharing(android.util.Pair<android.view.View,android.view.View> videoRenderViews, android.view.View sharingView) Constructs an audio/video and share media option.
MediaOption.CompositedVideoLayout	getCompositedVideoLayout() Returns the video layout of the active speaker and other attendees for the group video call.
MediaOption.CompositedVideoLayout	getLayout() Deprecated. please use getCompositedVideoLayout()
android.view.View	getLocalView()
java.lang.String	getPin() If join as moderator, PIN should be a host key, else PIN should be a meeting password.
android.view.View	getRemoteView()
android.view.View	getSharingView()
boolean	hasSharing() Whether content sharing is enabled.
boolean	hasVideo() Whether video is enabled.
boolean	isModerator() If true, join the meeting as a moderator.
void	setCompositedVideoLayout(MediaOption.CompositedVideoLayout compositedLayout) Set the video layout of the active speaker and other attendees for the group video call.
void	setLayout(MediaOption.CompositedVideoLayout layout) Deprecated. please use setCompositedVideoLayout(CompositedVideoLayout)
void	setModerator(boolean moderator) If true, join the meeting as a moderator.
void	setPin(java.lang.String pin) If join as moderator, PIN should be a host key, else PIN should be a meeting password.

Methods inherited from class java.lang.Object

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

Method Detail

audioOnly

public static MediaOption audioOnly()

Constructs an audio only media option.

Since:

0.1

audioVideo

public static MediaOption audioVideo(@NonNull
                                     android.view.View localView,
                                     @NonNull
                                     android.view.View remoteView)

Constructs an audio and video media option.

Parameters:

localView - Video view for self.

remoteView - Video view for remote

Since:

0.1

audioVideo

public static MediaOption audioVideo(@Nullable
                                     android.util.Pair<android.view.View,android.view.View> videoRenderViews)

Constructs an audio and video media option.

Parameters:

videoRenderViews - Local video view and remote video view.

Since:

1.3.0

audioVideoSharing

public static MediaOption audioVideoSharing(@Nullable
                                            android.util.Pair<android.view.View,android.view.View> videoRenderViews,
                                            @Nullable
                                            android.view.View sharingView)

Constructs an audio/video and share media option.

Parameters:

videoRenderViews - Local video view and remote video view.

sharingView - share view for remote.

Since:

1.3.0

hasVideo

public boolean hasVideo()

Whether video is enabled.

Returns:

False if neither local or remote video is enabled. Otherwise, true.

Since:

0.1

hasSharing

public boolean hasSharing()

Whether content sharing is enabled.

Returns:

true if content sharing is enabled. Otherwise, false.

Since:

1.3.0

getRemoteView

public android.view.View getRemoteView()

Returns:

The remote video view

Since:

0.1

getLocalView

public android.view.View getLocalView()

Returns:

The local video view

Since:

0.1

getSharingView

public android.view.View getSharingView()

Returns:

The sharing view

Since:

1.3.0

getLayout

public MediaOption.CompositedVideoLayout getLayout()

Deprecated. please use getCompositedVideoLayout()

Returns the video layout of the active speaker and other attendees for the group video call.

Since:

2.5.0

getCompositedVideoLayout

public MediaOption.CompositedVideoLayout getCompositedVideoLayout()

Returns the video layout of the active speaker and other attendees for the group video call.

Since:

2.8.0

setLayout

public void setLayout(MediaOption.CompositedVideoLayout layout)

Deprecated. please use setCompositedVideoLayout(CompositedVideoLayout)

Set the video layout of the active speaker and other attendees for the group video call.

Since:

2.5.0

setCompositedVideoLayout

public void setCompositedVideoLayout(MediaOption.CompositedVideoLayout compositedLayout)

Set the video layout of the active speaker and other attendees for the group video call.

Since:

2.8.0

isModerator

public boolean isModerator()

If true, join the meeting as a moderator.

Since:

2.6.0

setModerator

public void setModerator(boolean moderator)

If true, join the meeting as a moderator.

Since:

2.6.0

getPin

public java.lang.String getPin()

If join as moderator, PIN should be a host key, else PIN should be a meeting password.

Since:

2.6.0

setPin

public void setPin(java.lang.String pin)

If join as moderator, PIN should be a host key, else PIN should be a meeting password.

Since:

2.6.0