com.wowza.gocoder.sdk.api.broadcast

Interface WZBroadcastAPI.Broadcaster

All Known Subinterfaces:

WZBroadcastAPI.AudioBroadcaster, WZBroadcastAPI.VideoBroadcaster, WZSinkAPI.AudioSink, WZSinkAPI.MediaCodecAudioSink, WZSinkAPI.MediaCodecVideoSink, WZSinkAPI.StreamingAudioSink, WZSinkAPI.StreamingVideoSink, WZSinkAPI.VideoSink

All Known Implementing Classes:

WZAudioDevice, WZCameraView, WZGLBroadcaster, WZH264Broadcaster, WZMP4Broadcaster, WZMP4Writer

Enclosing class:

WZBroadcastAPI

public static interface WZBroadcastAPI.Broadcaster

The Broadcaster interface defines the methods that must be implemented by classes developed as broadcast components with instances registered with an instance of the WZBroadcast class via an instance of the WZBroadcastConfig class.

Method Summary

Modifier and Type	Method and Description
WZBroadcastConfig	getBroadcastConfig() Returns the configuration settings for an active broadcast session.
WZStatus	getBroadcasterStatus() Returns the status for a broadcast component
WZStatus	getStatus() Deprecated. use getBroadcasterStatus() instead
WZStatus	prepareForBroadcast(WZBroadcastConfig broadcastConfig) This method is called to initialize each component of a broadcast.
WZStatus	startBroadcasting() This method is called on each broadcast component to begin a live streaming broadcast.
WZStatus	stopBroadcasting() This method is called on each broadcast component to end a live streaming broadcast.

Method Detail

prepareForBroadcast

WZStatus prepareForBroadcast(WZBroadcastConfig broadcastConfig)

This method is called to initialize each component of a broadcast. Upon successful initialization, each component must set it's status to WZState.READY or WZState.IDLE and indicate the error in the status as well.

Parameters:

broadcastConfig - The broadcast configuration

Returns:

The overall status after transitioning each broadcast component to WZState.READY

getBroadcastConfig

WZBroadcastConfig getBroadcastConfig()

Returns the configuration settings for an active broadcast session. Note that this should only return a non-null value in between calls to prepareForBroadcast() and stopBroadcasting()

Returns:

the configuration settings for the active broadcast session or the broadcast session currently in the preparation stage

startBroadcasting

WZStatus startBroadcasting()

This method is called on each broadcast component to begin a live streaming broadcast. Upon success, each component must set it's status to WZState.RUNNING or WZState.IDLE and indicate the error in the status as well

Returns:

The overall status after transitioning each broadcast component to WZState.RUNNING

stopBroadcasting

WZStatus stopBroadcasting()

This method is called on each broadcast component to end a live streaming broadcast. Upon success, each component must set it's status to WZState.IDLE

Returns:

The overall status after transitioning each broadcast component to WZState.IDLE

getBroadcasterStatus

WZStatus getBroadcasterStatus()

Returns the status for a broadcast component

getStatus

WZStatus getStatus()

Deprecated. use getBroadcasterStatus() instead