io.straas.android.sdk.streaming

Class StreamManager

java.lang.Object

io.straas.android.sdk.streaming.StreamManager

public class StreamManager
extends Object

StreamManager is used to manage a rtmp client for Straas.

To construct a StreamManager, you have to call initialize(Identity) or initialize(Identity, Bundle) to get your result. These methods will check your developer credential, if it passed, you will get a StreamManager. Then, you can use methods in StreamManager to start live streaming.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StreamManager.StreamState Show state of StreamManager.

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATE_CONNECTING The state StreamManager is trying to create a live event or establish rtmp connection.
static int	STATE_DISCONNECTING The state StreamManager is trying to disconnect.
static int	STATE_IDLE The initial state or the state after destroy()
static int	STATE_PREPARED The state after prepare(io.straas.android.sdk.streaming.StreamConfig, android.view.TextureView) finishes successfully.
static int	STATE_PREPARING The state StreamManager is executing StreamManager.
static int	STATE_STREAMING The state StreamManager is streaming.

Method Summary

Modifier and Type	Method and Description
void	addAllEventListener(EventListener... listeners)
boolean	addEventListener(EventListener listener)
com.google.android.gms.tasks.Task<Void>	cleanLiveEvent(String liveId) Deprecated. Use endLiveEvent(String) instead.
com.google.android.gms.tasks.Task<String>	createLiveEvent(LiveEventConfig config) Create a live event.
com.google.android.gms.tasks.Task<Void>	destroy() Destroy StreamManager.
com.google.android.gms.tasks.Task<Void>	endLiveEvent(String liveId) Sets a live event state to ended.
int	getStreamState() Gets current StreamManager state.
StreamStatsReport	getStreamStatsReport() Gets the instant snapshot for StreamStatsReport.
static com.google.android.gms.tasks.Task<StreamManager>	initialize(Identity identity) Constructs a StreamManager if you are a authorized developer.
static void	initialize(Identity identity, Bundle bundle) Constructs a StreamManager and return it to your class implementing ScreencastSession via the callback ScreencastSession.onStreamManagerInitComplete(Task<>) if you are a authorized developer.
boolean	isAudioEnabled() Returns the enabled status of audio.
com.google.android.gms.tasks.Task<Void>	prepare(ScreencastStreamConfig config) Checks if ScreencastStreamConfig is valid, then initializes microphone and codec.
com.google.android.gms.tasks.Task<CameraController>	prepare(StreamConfig config, TextureView preview) Initializes camera, codec, microphone, you will be able to preview the live video after prepare success.
void	removeAllEventListener() Remove all event listener, no one could receive future event.
boolean	removeEventListener(EventListener listener)
void	setAudioEnabled(boolean enabled) Sets the enabled status of audio.
boolean	setFilter(BaseImageFilter filter) Sets filter for video.
void	setStreamStatsReportUpdatePeriod(int periodMs) Sets the update period in millis for stream statistics report.
com.google.android.gms.tasks.Task<String>	startStreaming(String liveId) Deprecated. Use startStreamingWithLiveId(java.lang.String) instead.
com.google.android.gms.tasks.Task<Void>	startStreamingWithLiveId(String liveId) Starts to stream.
com.google.android.gms.tasks.Task<Void>	startStreamingWithStreamKey(String streamKey) Starts to stream.
com.google.android.gms.tasks.Task<Void>	stopStreaming() Stops the operation doing in startStreamingWithLiveId(String) or startStreamingWithStreamKey(String), that is connecting and streaming.

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

The initial state or the state after destroy()

See Also:

Constant Field Values

STATE_PREPARING

public static final int STATE_PREPARING

The state StreamManager is executing StreamManager.

See Also:

Constant Field Values

STATE_PREPARED

public static final int STATE_PREPARED

The state after prepare(io.straas.android.sdk.streaming.StreamConfig, android.view.TextureView) finishes successfully. You can start streaming by invoking startStreamingWithLiveId(String) or startStreamingWithStreamKey(String) in this state.

See Also:

Constant Field Values

STATE_CONNECTING

public static final int STATE_CONNECTING

The state StreamManager is trying to create a live event or establish rtmp connection.

See Also:

Constant Field Values

STATE_STREAMING

public static final int STATE_STREAMING

The state StreamManager is streaming.

See Also:

Constant Field Values

STATE_DISCONNECTING

public static final int STATE_DISCONNECTING

The state StreamManager is trying to disconnect.

See Also:

Constant Field Values

Method Detail

initialize

public static com.google.android.gms.tasks.Task<StreamManager> initialize(Identity identity)

Constructs a StreamManager if you are a authorized developer.

Parameters:

identity - Any task of the StreamManager you get will be executed by this Identity.

Returns:

You could get a StreamManager by the Task if task succeeded.

initialize

public static void initialize(Identity identity,
                              Bundle bundle)

Constructs a StreamManager and return it to your class implementing ScreencastSession via the callback ScreencastSession.onStreamManagerInitComplete(Task<>) if you are a authorized developer. Also starting a foreground screencast Service to run ScreencastSession.

Parameters:

identity - Any task of the StreamManager you get will be executed by this Identity.

bundle - provides any information for screencast setup or other purposes, this will be delivered to ScreencastSession.onSessionCreate(Context, SessionListener, Bundle)

See Also:

Service.startForeground(int, Notification), Settings.canDrawOverlays(Context)

prepare

public com.google.android.gms.tasks.Task<CameraController> prepare(StreamConfig config,
                                                                   TextureView preview)

Initializes camera, codec, microphone, you will be able to preview the live video after prepare success.

This method should only be called when the StreamManager status is STATE_IDLE or STATE_PREPARED.

Parameters:

config - provides information of stream, see StreamConfig

preview - TextureView to preview video

Returns:

You could get a CameraController by the Task if task succeeded.

prepare

public com.google.android.gms.tasks.Task<Void> prepare(ScreencastStreamConfig config)

Checks if ScreencastStreamConfig is valid, then initializes microphone and codec.

This method should only be called when the StreamManager status is STATE_IDLE or STATE_PREPARED.

Parameters:

config - provides streaming information for screencast, see ScreencastStreamConfig

Returns:

You could get the result by this Task.

setFilter

public boolean setFilter(@Nullable
                         BaseImageFilter filter)

Sets filter for video.

This method should only be called when the getStreamState() >= STATE_PREPARED

Parameters:

filter - see BaseImageFilter. Set this to null to disable filter.

Returns:

true if operation successes

setAudioEnabled

public void setAudioEnabled(boolean enabled)

Sets the enabled status of audio. If the audio is not enabled, it means there is no sound in the audio stream.

This method should only be called when the getStreamState() >= STATE_PREPARED

Parameters:

enabled - True if the audio is enabled, false otherwise.

See Also:

isAudioEnabled()

isAudioEnabled

public boolean isAudioEnabled()

Returns the enabled status of audio. The default value is true.

This method should only be called when the getStreamState() >= STATE_PREPARED

Returns:

True if the audio is enabled, false otherwise.

See Also:

setAudioEnabled(boolean)

createLiveEvent

public com.google.android.gms.tasks.Task<String> createLiveEvent(@NonNull
                                                                 LiveEventConfig config)

Create a live event. A member can only have one not-ended live event. It means you have to set all your own live events to ended before create a new one.

You may receive StreamException.LiveCountLimitException from the returned task if there is a not-ended live event already. If so, you can use startStreamingWithLiveId(String) or endLiveEvent(String) to handle the live event getting by StreamException.LiveCountLimitException.getLiveId().

This method should only be called when the getStreamState() <= STATE_PREPARED

Note: this method is only available for authorized users. That means you shouldn't call this when the current member is Identity.GUEST.

Parameters:

config - configuration of live event

Returns:

You could get a live event id by the Task if task succeeded.

startStreaming

@Deprecated
public com.google.android.gms.tasks.Task<String> startStreaming(@NonNull
                                                                            String liveId)

Deprecated. Use startStreamingWithLiveId(java.lang.String) instead.

Starts to stream. You could only use this method to stream to the live events belonging to the current member.

This method should only be called when the StreamManager status is STATE_PREPARED.

Note: this method is only available for authorized users. That means you shouldn't call this when the current member is Identity.GUEST.

Parameters:

liveId - live event id, you can create this by createLiveEvent(LiveEventConfig)

Returns:

You could get a live event id by the Task if task succeeded.

startStreamingWithLiveId

public com.google.android.gms.tasks.Task<Void> startStreamingWithLiveId(@NonNull
                                                                        String liveId)

Starts to stream. You could only use this method to stream to the live events that belong to the current member.

This method should only be called when the StreamManager status is STATE_PREPARED.

Note: this method is only available for authorized users. That means you shouldn't call this when the current member is Identity.GUEST.

Parameters:

liveId - live event id, you can create this by createLiveEvent(LiveEventConfig)

Returns:

You could get a live event id by the Task if task succeeded.

startStreamingWithStreamKey

public com.google.android.gms.tasks.Task<Void> startStreamingWithStreamKey(@NonNull
                                                                           String streamKey)

Starts to stream. If you have the stream key, you could use this method to publish your stream even if current member is Identity.GUEST.

This method should only be called when the StreamManager status is STATE_PREPARED.

Parameters:

streamKey - stream key

Returns:

You could get the result by this Task.

addEventListener

public boolean addEventListener(EventListener listener)

Parameters:

listener - Listens result of connection and other events. See EventListener.

Returns:

return true if listener add successfully

addAllEventListener

public void addAllEventListener(EventListener... listeners)

Parameters:

listeners - Listens result of connection and other events. See EventListener.

removeEventListener

public boolean removeEventListener(EventListener listener)

Parameters:

listener - Remove listener which doesn't want to receive future event. See EventListener.

Returns:

return true if listener remove successfully

removeAllEventListener

public void removeAllEventListener()

Remove all event listener, no one could receive future event. See EventListener.

stopStreaming

public com.google.android.gms.tasks.Task<Void> stopStreaming()

Stops the operation doing in startStreamingWithLiveId(String) or startStreamingWithStreamKey(String), that is connecting and streaming. This method won't set the current live event to ENDED, you can use endLiveEvent(String) if needed.

This method should only be called when the StreamManager status is STATE_CONNECTING or STATE_STREAMING.

Returns:

You could get the result by this Task.

destroy

public com.google.android.gms.tasks.Task<Void> destroy()

Destroy StreamManager. This method will do operation in stopStreaming() and release resources generated at prepare(io.straas.android.sdk.streaming.StreamConfig, android.view.TextureView). This method won't set current the live event to ENDED, you can use endLiveEvent(String) if needed.

This method shouldn't be called when the StreamManager status is STATE_IDLE.

Returns:

You could get the result by this Task.

cleanLiveEvent

@Deprecated
public com.google.android.gms.tasks.Task<Void> cleanLiveEvent(@NonNull
                                                                          String liveId)

Deprecated. Use endLiveEvent(String) instead.

Sets a live event state to ended. Only the owner of live event can call this method to set state ended.

Note: this method is only available for authorized users. That means you shouldn't call this when the current member is Identity.GUEST.

Parameters:

liveId - live event id

Returns:

You could get the result by this Task.

endLiveEvent

public com.google.android.gms.tasks.Task<Void> endLiveEvent(@NonNull
                                                            String liveId)

Sets a live event state to ended. Only the owner of live event can call this method to set state ended.

Note: this method is only available for authorized users. That means you shouldn't call this when the current member is Identity.GUEST.

Parameters:

liveId - live event id

Returns:

You could get the result by this Task.

getStreamState

public int getStreamState()

Gets current StreamManager state.

Returns:

StreamManager.StreamState

getStreamStatsReport

@Nullable
public StreamStatsReport getStreamStatsReport()

Gets the instant snapshot for StreamStatsReport.

The returned stream statistics report instance won't update automatically, you have to call this method every time you want to get the instant report.

Alternatively, you could use addEventListener(io.straas.android.sdk.streaming.interfaces.EventListener) to subscribe event EventListener.onStreamStatsReportUpdate(StreamStatsReport) to receive the update of stream statistics report periodically. You can specify the update period of stream statistics report by setStreamStatsReportUpdatePeriod(int). Default value is one second.

This method should only be called when the StreamManager status is STATE_STREAMING or STATE_DISCONNECTING.

Returns:

StreamStatsReport

setStreamStatsReportUpdatePeriod

public void setStreamStatsReportUpdatePeriod(int periodMs)

Sets the update period in millis for stream statistics report.

Parameters:

periodMs - the update period in millisecond for EventListener.onStreamStatsReportUpdate(StreamStatsReport).