SkylinkMedia.MediaState
extends Enum<E extends Enum<E>>| java.lang.Object | ||
| ↳ | java.lang.Enum<E extends java.lang.Enum<E>> | |
| ↳ | sg.com.temasys.skylink.sdk.rtc.SkylinkMedia.MediaState | |
Class Overview
The possible states that a SkylinkMedia can use to describe the media it represents.
Note that the SkylinkMedia.MediaState of a media takes on values relative to
the Peer perceiving the media, and is actively synchronized between the sending Peer
and receiving Peer(s) IF AND ONLY IF the media is currently being sent between the two sides.
For instance, if a media is currently NOT being sent to remote Peers, it is possible that
the local SkylinkMedia has state ACTIVE while the remote
SkylinkMedia representing the same media has state UNAVAILABLE.
In this scenario, it means that for the media creating Peer,
the media is represented as still having active contents, while for the remote Peer(s),
the same media is represented as not being sent.
Summary
| Enum Values | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| SkylinkMedia.MediaState | ACTIVE | Media has active contents. | |||||||||
| SkylinkMedia.MediaState | MUTED | Media is not being sent between Peers, but in it's place, black frames are being sent. | |||||||||
| SkylinkMedia.MediaState | STOPPED | Media is not being sent between Peers, neither are black frames being sent in its place. | |||||||||
| SkylinkMedia.MediaState | UNAVAILABLE | Media is not being sent between Peers. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static SkylinkMedia.MediaState | valueOf(String name) | ||||||||||
| final static MediaState[] | values() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Enum
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.Comparable
| |||||||||||
Enum Values
public static final SkylinkMedia.MediaState MUTED
Media is not being sent between Peers, but in it's place, black frames are being sent.
public static final SkylinkMedia.MediaState STOPPED
public static final SkylinkMedia.MediaState UNAVAILABLE
Media is not being sent between Peers. It can potentially be sent again. It could also be permanently unavailable, for e.g. because it has been disposed.