WZAudioDevice (GoCoder SDK Android API)

java.lang.Object
- com.wowza.gocoder.sdk.api.devices.WZAudioDevice

All Implemented Interfaces:

WZBroadcastAPI.AudioBroadcaster, WZBroadcastAPI.Broadcaster
```
public class WZAudioDevice
extends Object
implements WZBroadcastAPI.AudioBroadcaster
```
Encode an audio stream 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 WZAudioDevice.AudioSampleListener

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WZAudioDevice.AudioSampleListener`

Constructor Summary

Constructors
Constructor and Description

WZAudioDevice()

Constructors
Constructor and Description
`WZAudioDevice()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAudioSource()` Returns the actively configured input device for capturing audio
`WZBroadcastConfig`	`getBroadcastConfig()` Returns the configuration settings for an active broadcast session.
`WZStatus`	`getBroadcasterStatus()` Returns the status for a broadcast component
`WZBroadcastConfig`	`getSamplingConfig()` Get the configuration used for the audio sampler
`WZStatus`	`getStatus()`
`boolean`	`isAudioEnabled()` Indicates if a broadcast component is enabled or not
`boolean`	`isAudioPaused()` Indicates if a broadcast component is paused or not
`boolean`	`isMuted()` deprecated Use `isAudioPaused()`
`boolean`	`isSamplingAudio()` Indicates if audio samples are currently being read from the audio input device and passed along to sample listeners or not
`WZStatus`	`prepareForBroadcast(WZBroadcastConfig broadcastConfig)` This method is called to initialize each component of a broadcast.
`void`	`registerAudioSampleListener(WZAudioDevice.AudioSampleListener sampleListener)` Registers an audio sample listener to receive raw PCM audio samples
`void`	`setAudioEnabled(boolean enabled)` Set or unset the flag indicating that a broadcast component is enabled
`void`	`setAudioPaused(boolean paused)` Set or unset the flag indicating that a broadcast component is in a paused state
`void`	`setAudioSource(int audioSource)` Sets the actively configured input device for capturing audio.
`void`	`setMuted(boolean muted)` deprecated Use `setAudioPaused(boolean)`
`void`	`setSamplingConfig(WZBroadcastConfig samplingConfig)` Set 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(WZBroadcastConfig samplingConfig)` Starts the audio sampler with the specified audio configuration
`WZStatus`	`startBroadcasting()` This method is called on each broadcast component to begin a live streaming broadcast.
`void`	`stopAudioSampler()` Stops the audio sampler
`WZStatus`	`stopBroadcasting()` This method is called on each broadcast component to end a live streaming broadcast.
`void`	`unregisterAudioSampleListener(WZAudioDevice.AudioSampleListener sampleListener)` Unregisters a previously registered audio sample listener

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WZAudioDevice
```
public WZAudioDevice()
```
- Method Detail
  - getAudioSource
```
public int getAudioSource()
```
    Returns the actively configured input device for capturing audio
    
    Returns:
    
    An identifier for the active audio source. Possible values are those listed at android.media.MediaRecorder.AudioSource
    
    See Also:
    
    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 those listed at android.media.MediaRecorder.AudioSource. The default value is MediaRecorder.AudioSource.CAMCORDER. Note that setting this while audio is actively being captured will have no effect until a new capture session is started. Setting this to an invalid value will cause an error to occur at session begin.
    
    See Also:
    
    android.media.MediaRecorder.AudioSource
  - getSamplingConfig
```
public WZBroadcastConfig getSamplingConfig()
```
    Get the configuration used for the audio sampler
    
    Returns:
    
    the configuration used for the audio sampler
  - setSamplingConfig
```
public void setSamplingConfig(WZBroadcastConfig samplingConfig)
```
    Set the configuration used by the audio sampler
    
    Parameters:
    
    samplingConfig - the configuration used by the audio sampler
  - isMuted
```
public boolean isMuted()
```
    deprecated Use isAudioPaused()
  - setMuted
```
public void setMuted(boolean muted)
```
    deprecated Use setAudioPaused(boolean)
  - registerAudioSampleListener
```
public void registerAudioSampleListener(WZAudioDevice.AudioSampleListener sampleListener)
```
    Registers an audio sample listener to receive raw PCM audio samples
    
    Parameters:
    
    sampleListener - an instance implementing the WZAudioDevice.AudioSampleListener interface
  - unregisterAudioSampleListener
```
public void unregisterAudioSampleListener(WZAudioDevice.AudioSampleListener sampleListener)
```
    Unregisters a previously registered audio sample listener
    
    Parameters:
    
    sampleListener - an instance implementing the WZAudioDevice.AudioSampleListener interface
  - isSamplingAudio
```
public boolean isSamplingAudio()
```
    Indicates if audio samples are currently being read from the audio input device and passed along to sample listeners or not
    
    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(WZBroadcastConfig 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 WZBroadcastConfig getBroadcastConfig()
```
    Description copied from interface: WZBroadcastAPI.Broadcaster
    
    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()
    
    Specified by:
    
    getBroadcastConfig in interface WZBroadcastAPI.Broadcaster
    
    Returns:
    
    the configuration settings for the active broadcast session or the broadcast session currently in the preparation stage
  - getBroadcasterStatus
```
public WZStatus getBroadcasterStatus()
```
    Description copied from interface: WZBroadcastAPI.Broadcaster
    
    Returns the status for a broadcast component
    
    Specified by:
    
    getBroadcasterStatus in interface WZBroadcastAPI.Broadcaster
  - getStatus
```
public WZStatus getStatus()
```
    Specified by:
    
    getStatus in interface WZBroadcastAPI.Broadcaster
  - isAudioEnabled
```
public boolean isAudioEnabled()
```
    Description copied from interface: WZBroadcastAPI.AudioBroadcaster
    
    Indicates if a broadcast component is enabled or not
    
    Specified by:
    
    isAudioEnabled in interface WZBroadcastAPI.AudioBroadcaster
    
    Returns:
    
    true if the broadcast component is enabled, false otherwise
  - setAudioEnabled
```
public void setAudioEnabled(boolean enabled)
```
    Description copied from interface: WZBroadcastAPI.AudioBroadcaster
    
    Set or unset the flag indicating that a broadcast component is enabled
    
    Specified by:
    
    setAudioEnabled in interface WZBroadcastAPI.AudioBroadcaster
    
    Parameters:
    
    enabled - true if the audio broadcast component should be enabled, false otherwise
  - isAudioPaused
```
public boolean isAudioPaused()
```
    Description copied from interface: WZBroadcastAPI.AudioBroadcaster
    
    Indicates if a broadcast component is paused or not
    
    Specified by:
    
    isAudioPaused in interface WZBroadcastAPI.AudioBroadcaster
    
    Returns:
    
    true if the audio broadcast component is active, false otherwise
  - setAudioPaused
```
public void setAudioPaused(boolean paused)
```
    Description copied from interface: WZBroadcastAPI.AudioBroadcaster
    
    Set or unset the flag indicating that a broadcast component is in a paused state
    
    Specified by:
    
    setAudioPaused in interface WZBroadcastAPI.AudioBroadcaster
    
    Parameters:
    
    paused - true if the audio broadcast component should be placed in a paused state, false otherwise
  - prepareForBroadcast
```
public WZStatus prepareForBroadcast(WZBroadcastConfig broadcastConfig)
```
    Description copied from interface: WZBroadcastAPI.Broadcaster
    
    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.
    
    Specified by:
    
    prepareForBroadcast in interface WZBroadcastAPI.Broadcaster
    
    Parameters:
    
    broadcastConfig - The broadcast configuration
    
    Returns:
    
    The overall status after transitioning each broadcast component to WZState.READY
  - startBroadcasting
```
public WZStatus startBroadcasting()
```
    Description copied from interface: WZBroadcastAPI.Broadcaster
    
    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
    
    Specified by:
    
    startBroadcasting in interface WZBroadcastAPI.Broadcaster
    
    Returns:
    
    The overall status after transitioning each broadcast component to WZState.RUNNING
  - stopBroadcasting
```
public WZStatus stopBroadcasting()
```
    Description copied from interface: WZBroadcastAPI.Broadcaster
    
    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
    
    Specified by:
    
    stopBroadcasting in interface WZBroadcastAPI.Broadcaster
    
    Returns:
    
    The overall status after transitioning each broadcast component to WZState.IDLE

Class WZAudioDevice

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WZAudioDevice

Method Detail

getAudioSource

setAudioSource

getSamplingConfig

setSamplingConfig

isMuted

setMuted

registerAudioSampleListener

unregisterAudioSampleListener

isSamplingAudio

startAudioSampler

startAudioSampler

stopAudioSampler

getBroadcastConfig

getBroadcasterStatus

getStatus

isAudioEnabled

setAudioEnabled

isAudioPaused

setAudioPaused

prepareForBroadcast

startBroadcasting

stopBroadcasting