com.wowza.gocoder.sdk.api.devices

Class WOWZAudioDevice

java.lang.Object

com.wowza.gocoder.sdk.api.devices.WOWZAudioDevice

All Implemented Interfaces:

WOWZBroadcastAPI.AudioBroadcaster, WOWZBroadcastAPI.Broadcaster

public class WOWZAudioDevice
extends java.lang.Object
implements WOWZBroadcastAPI.AudioBroadcaster

Use the WOWZAudioDevice class to encode audio streams. The object wraps a media encoder running on a dedicated thread. The various control messages may be sent from arbitrary threads (typically the app UI thread). The encoder thread manages both sides of the encoder, feeding and draining.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WOWZAudioDevice.AudioSampleListener

Constructor Summary

Constructors

Constructor and Description
WOWZAudioDevice()

Method Summary

Modifier and Type	Method and Description
int	getAudioSource() Gets the actively configured input device for capturing audio.
WOWZBroadcastConfig	getBroadcastConfig() Gets the configuration settings for an active broadcast session.
WOWZStatus	getBroadcasterStatus() Gets the status for a broadcast component.
WOWZBroadcastConfig	getSamplingConfig() Gets the configuration of the audio sampler.
WOWZStatus	getStatus()
boolean	isAudioEnabled() Checks whether an audio broadcast component is enabled.
boolean	isAudioPaused() Checks whether an audio broadcast component is paused.
boolean	isMuted() deprecated Use isAudioPaused() instead.
boolean	isSamplingAudio() Checks whether audio samples are currently being read from the audio input device and passed along to sample listeners.
WOWZStatus	prepareForBroadcast(WOWZBroadcastConfig broadcastConfig) Initializes each component of a broadcast.
void	registerAudioSampleListener(WOWZAudioDevice.AudioSampleListener sampleListener) Registers an audio sample listener to receive raw PCM audio samples.
void	setAudioEnabled(boolean enabled) Sets the flag indicating that an audio broadcast component is enabled.
void	setAudioPaused(boolean paused) Sets the flag indicating that an audio broadcast component is paused.
void	setAudioSource(int audioSource) Sets the actively configured input device for capturing audio.
void	setMuted(boolean muted) deprecated Use setAudioPaused(boolean) instead.
void	setSamplingConfig(WOWZBroadcastConfig samplingConfig) Sets the configuration used by the audio sampler.
void	startAudioSampler() Starts the audio sampler to read sample from the audio input device to pass along to the registered sample listeners.
void	startAudioSampler(WOWZBroadcastConfig samplingConfig) Starts the audio sampler with the specified audio configuration.
WOWZStatus	startBroadcasting() Called on each broadcast component to begin a live streaming broadcast.
void	stopAudioSampler() Stops the audio sampler
WOWZStatus	stopBroadcasting() Called on each broadcast component to end a live streaming broadcast.
void	unregisterAudioSampleListener(WOWZAudioDevice.AudioSampleListener sampleListener) Unregisters an audio sample listener.

Methods inherited from class java.lang.Object

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

Constructor Detail

WOWZAudioDevice

public WOWZAudioDevice()

Method Detail

getAudioSource

public int getAudioSource()

Gets the actively configured input device for capturing audio.

Returns:

An identifier for the active audio source. Possible values are listed at android.media.MediaRecorder.AudioSource.

setAudioSource

public void setAudioSource(int audioSource)

Sets the actively configured input device for capturing audio.

Parameters:

audioSource - An identifier for the active audio source. Possible values are listed at android.media.MediaRecorder.AudioSource. The default is MediaRecorder.AudioSource.CAMCORDER. This setting doesn't affect audio that's actively being captured. It has no effect until a new capture session starts. Setting this to an invalid value will cause an error to occur at the beginning of the session.

getSamplingConfig

public WOWZBroadcastConfig getSamplingConfig()

Gets the configuration of the audio sampler.

Returns:

The audio sampler configuration.

setSamplingConfig

public void setSamplingConfig(WOWZBroadcastConfig samplingConfig)

Sets the configuration used by the audio sampler.

Parameters:

samplingConfig - The configuration used by the audio sampler.

isMuted

public boolean isMuted()

deprecated Use isAudioPaused() instead.

setMuted

public void setMuted(boolean muted)

deprecated Use setAudioPaused(boolean) instead.

registerAudioSampleListener

public void registerAudioSampleListener(WOWZAudioDevice.AudioSampleListener sampleListener)

Registers an audio sample listener to receive raw PCM audio samples.

Parameters:

sampleListener - An instance implementing the WOWZAudioDevice.AudioSampleListener interface.

unregisterAudioSampleListener

public void unregisterAudioSampleListener(WOWZAudioDevice.AudioSampleListener sampleListener)

Unregisters an audio sample listener.

Parameters:

sampleListener - An instance implementing the WOWZAudioDevice.AudioSampleListener interface.

isSamplingAudio

public boolean isSamplingAudio()

Checks whether audio samples are currently being read from the audio input device and passed along to sample listeners.

Returns:

True if audio samples are currently being read from the audio input device and passed along to sample listeners; false otherwise.

startAudioSampler

public void startAudioSampler(WOWZBroadcastConfig samplingConfig)

Starts the audio sampler with the specified audio configuration.

Parameters:

samplingConfig - A configuration specification whose audio properties will be used.

startAudioSampler

public void startAudioSampler()

Starts the audio sampler to read sample from the audio input device to pass along to the registered sample listeners.

stopAudioSampler

public void stopAudioSampler()

Stops the audio sampler

getBroadcastConfig

public WOWZBroadcastConfig getBroadcastConfig()

Description copied from interface: WOWZBroadcastAPI.Broadcaster

Gets the configuration settings for an active broadcast session. Only returns a non-null value between calls to prepareForBroadcast() and stopBroadcasting().

Specified by:

getBroadcastConfig in interface WOWZBroadcastAPI.Broadcaster

Returns:

The configuration settings for the active broadcast session or the broadcast session currently being prepared.

getBroadcasterStatus

public WOWZStatus getBroadcasterStatus()

Description copied from interface: WOWZBroadcastAPI.Broadcaster

Gets the status for a broadcast component.

Specified by:

getBroadcasterStatus in interface WOWZBroadcastAPI.Broadcaster

getStatus

public WOWZStatus getStatus()

Specified by:

getStatus in interface WOWZBroadcastAPI.Broadcaster

isAudioEnabled

public boolean isAudioEnabled()

Description copied from interface: WOWZBroadcastAPI.AudioBroadcaster

Checks whether an audio broadcast component is enabled.

Specified by:

isAudioEnabled in interface WOWZBroadcastAPI.AudioBroadcaster

Returns:

True if the component is enabled; false otherwise.

setAudioEnabled

public void setAudioEnabled(boolean enabled)

Description copied from interface: WOWZBroadcastAPI.AudioBroadcaster

Sets the flag indicating that an audio broadcast component is enabled.

Specified by:

setAudioEnabled in interface WOWZBroadcastAPI.AudioBroadcaster

Parameters:

enabled - True if the component should be enabled; false otherwise.

isAudioPaused

public boolean isAudioPaused()

Description copied from interface: WOWZBroadcastAPI.AudioBroadcaster

Checks whether an audio broadcast component is paused.

Specified by:

isAudioPaused in interface WOWZBroadcastAPI.AudioBroadcaster

Returns:

True if the component is paused; false otherwise.

setAudioPaused

public void setAudioPaused(boolean paused)

Description copied from interface: WOWZBroadcastAPI.AudioBroadcaster

Sets the flag indicating that an audio broadcast component is paused.

Specified by:

setAudioPaused in interface WOWZBroadcastAPI.AudioBroadcaster

Parameters:

paused - True if the component should be paused; false otherwise.

prepareForBroadcast

public WOWZStatus prepareForBroadcast(WOWZBroadcastConfig broadcastConfig)

Description copied from interface: WOWZBroadcastAPI.Broadcaster

Initializes each component of a broadcast. Upon successful initialization, each component must set its status to WOWZState.READY or WOWZState.IDLE and also indicate the error in the status.

Specified by:

prepareForBroadcast in interface WOWZBroadcastAPI.Broadcaster

Parameters:

broadcastConfig - The broadcast configuration.

Returns:

The status after transitioning each broadcast component to WOWZState.READY.

startBroadcasting

public WOWZStatus startBroadcasting()

Description copied from interface: WOWZBroadcastAPI.Broadcaster

Called on each broadcast component to begin a live streaming broadcast. Upon success, each component must set its status to WOWZState.RUNNING or WOWZState.IDLE and also indicate the error in the status.

Specified by:

startBroadcasting in interface WOWZBroadcastAPI.Broadcaster

Returns:

The status after transitioning each broadcast component to WOWZState.RUNNING.

stopBroadcasting

public WOWZStatus stopBroadcasting()

Description copied from interface: WOWZBroadcastAPI.Broadcaster

Called on each broadcast component to end a live streaming broadcast. Upon success, each component must set its status to WOWZState.IDLE.

Specified by:

stopBroadcasting in interface WOWZBroadcastAPI.Broadcaster

Returns:

The status after transitioning each broadcast component to WOWZState.IDLE.