io.straas.android.sdk.media

Class LiveEventListener

java.lang.Object

io.straas.android.sdk.media.LiveEventListener

public class LiveEventListener
extends Object

This is for developer to listen live event state changes, you should call initWithLiveId(Identity, EventListener) to get the instance. Call start(String) to start observing changes and stop() to stop observing. You could observe the properties change like getBroadcastStateV2(), getBroadcastStartTimeInMS(), getCCU(), and getHitCount().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LiveEventListener.EventListener The listener to listen events sent by LiveEventListener.
static interface	LiveEventListener.State The state of LiveEventListener, may be STATE_IDLE, STATE_STARTING, or STATE_STARTED.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BROADCAST_STATE_DVR_PLAYBACK_AVAILABLE Means the live event state is still available for playback within amount of time temporarily when this event is not broadcasting for live dvr enabled live event.
static int	BROADCAST_STATE_ENDED Means the live event state is ended.
static int	BROADCAST_STATE_STARTED Means the live event is broadcasting.
static int	BROADCAST_STATE_STOPPED Means the live event is not broadcasting and state is not ended.
static int	BROADCAST_STATE_UNKNOWN The initial value before fetching any information about the live event.
static int	BROADCAST_STATE_WAITING_FOR_STREAM Means the live event is waiting for stream.
static int	STATE_IDLE Means the LiveEventListener is idle.
static int	STATE_STARTED Means the LiveEventListener has started.
static int	STATE_STARTING Means the LiveEventListener is starting.

Method Summary

Modifier and Type	Method and Description
androidx.lifecycle.LiveData<Long>	getBroadcastStartTimeInMS() Gets the broadcast start time of the live event.
androidx.lifecycle.LiveData<Integer>	getBroadcastStateV2() Gets the broadcastStateV2.
androidx.lifecycle.LiveData<Integer>	getCCU() Gets the CCU of the live event.
androidx.lifecycle.LiveData<Integer>	getHitCount() Gets the hit count of the live event.
String	getLiveId() Gets the id of current listening live event.
int	getState() Gets the state of LiveEventListener.
static com.google.android.gms.tasks.Task<LiveEventListener>	initWithLiveId(Identity identity, LiveEventListener.EventListener listener) Constructs a LiveEventListener if you are a authorized developer.
com.google.android.gms.tasks.Task<Void>	start(String liveId) Starts to listen the change of the live event related properties.
void	stop() Stops listening the live event related properties change.

Methods inherited from class java.lang.Object

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

Field Detail

STATE_IDLE

public static final int STATE_IDLE

Means the LiveEventListener is idle. In this state, you could call start(String) to listen live event state.

See Also:

getState(), Constant Field Values

STATE_STARTING

public static final int STATE_STARTING

Means the LiveEventListener is starting. In this state, you could wait for the result of start(String) or call stop() to stop it.

See Also:

getState(), Constant Field Values

STATE_STARTED

public static final int STATE_STARTED

Means the LiveEventListener has started. In this state, you could observe values change or call stop() if you don't want to observe anymore.

See Also:

getState(), Constant Field Values

BROADCAST_STATE_UNKNOWN

public static final int BROADCAST_STATE_UNKNOWN

The initial value before fetching any information about the live event.

See Also:

Constant Field Values

BROADCAST_STATE_STARTED

public static final int BROADCAST_STATE_STARTED

Means the live event is broadcasting.

See Also:

Constant Field Values

BROADCAST_STATE_STOPPED

public static final int BROADCAST_STATE_STOPPED

Means the live event is not broadcasting and state is not ended.

See Also:

Constant Field Values

BROADCAST_STATE_WAITING_FOR_STREAM

public static final int BROADCAST_STATE_WAITING_FOR_STREAM

Means the live event is waiting for stream. May caused when network issues happen on broadcaster or server side.

See Also:

Constant Field Values

BROADCAST_STATE_ENDED

public static final int BROADCAST_STATE_ENDED

Means the live event state is ended.

See Also:

Constant Field Values

BROADCAST_STATE_DVR_PLAYBACK_AVAILABLE

public static final int BROADCAST_STATE_DVR_PLAYBACK_AVAILABLE

Means the live event state is still available for playback within amount of time temporarily when this event is not broadcasting for live dvr enabled live event.

See Also:

Constant Field Values

Method Detail

initWithLiveId

public static com.google.android.gms.tasks.Task<LiveEventListener> initWithLiveId(Identity identity,
                                                                                  LiveEventListener.EventListener listener)

Constructs a LiveEventListener if you are a authorized developer.

Parameters:

identity - The user who fetches the live event information.

listener - The listener to listen events sent from LiveEventListener.

start

public com.google.android.gms.tasks.Task<Void> start(String liveId)

Starts to listen the change of the live event related properties.

You could only call this method when state is STATE_IDLE.

Parameters:

liveId - the live event id

Returns:

the start result

stop

public void stop()

Stops listening the live event related properties change.

You could call this method in any state.

getState

public int getState()

Gets the state of LiveEventListener.

Returns:

the state of LiveEventListener

See Also:

STATE_IDLE, STATE_STARTING, STATE_STARTED

getLiveId

public String getLiveId()

Gets the id of current listening live event.

Returns:

live event id

getBroadcastStateV2

public androidx.lifecycle.LiveData<Integer> getBroadcastStateV2()

Gets the broadcastStateV2.

The broadcastStateV2 may be BROADCAST_STATE_UNKNOWN, BROADCAST_STATE_STARTED, BROADCAST_STATE_STOPPED, BROADCAST_STATE_WAITING_FOR_STREAM, BROADCAST_STATE_ENDED or BROADCAST_STATE_DVR_PLAYBACK_AVAILABLE.

Returns:

the LiveData of broadcastStateV2

See Also:

BROADCAST_STATE_UNKNOWN, BROADCAST_STATE_STARTED, BROADCAST_STATE_STOPPED, BROADCAST_STATE_WAITING_FOR_STREAM, BROADCAST_STATE_ENDED, BROADCAST_STATE_DVR_PLAYBACK_AVAILABLE

getBroadcastStartTimeInMS

public androidx.lifecycle.LiveData<Long> getBroadcastStartTimeInMS()

Gets the broadcast start time of the live event.

The value is the unix time in milliseconds and the initial value is null.

Returns:

the LiveData of broadcast start time

getCCU

public androidx.lifecycle.LiveData<Integer> getCCU()

Gets the CCU of the live event.

The initial value is null.

Returns:

the LiveData of CCU

See Also:

doc

getHitCount

public androidx.lifecycle.LiveData<Integer> getHitCount()

Gets the hit count of the live event.

The initial value is null.

Returns:

the LiveData of hit count

See Also:

doc