WZStatus (GoCoder SDK Android API)

java.lang.Object
- com.wowza.gocoder.sdk.api.status.WZStatus

```
public class WZStatus
extends Object
```
The WZStatus is a thread-safe class for working with SDK component state and error properties.
Many of the SDK components include a getStatus() and the methods of the WZStatusCallback interface are passed a WZStatus argument indicating the current status of a live streaming broadcast.

Constructor Summary

Constructors
Constructor and Description
`WZStatus()` The default constructor
`WZStatus(int state)` Construct a new instance using the specified property values
`WZStatus(int state, WZError error)` Construct a new instance using the specified property values
`WZStatus(WZStatus other)` Construct a new instance using the property values from the specified instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WZError`	`clearLastError()` Clear the value of the last error property, leaving the state as is
`WZError`	`clearLastError(int newState)` Clear the value of the last error property and sets the state to the specified value
`WZError`	`getLastError()` Returns the last error reported
`WZError`	`getLastError(boolean clear)` Returns the last error reported and clears the last error property
`int`	`getState()` Returns the value of the state property
`boolean`	`isBuffering()` Returns true if the current state is `PREBUFFERING_STARTED`
`boolean`	`isComplete()` Returns true if the current state is `COMPLETE`
`boolean`	`isIdle()` Returns true if the current state is `IDLE`
`boolean`	`isPaused()` Returns true if the current state is `PAUSED`
`boolean`	`isReady()` Returns true if the current state is `READY`
`boolean`	`isRunning()` Returns true if the current state is `RUNNING`
`boolean`	`isShutdown()` Returns true if the current state is `SHUTDOWN`
`boolean`	`isStarting()` Returns true if the current state is `STARTING`
`boolean`	`isStopped()` Returns true if the current state is `STOPPED`
`boolean`	`isStopping()` Returns true if the current state is `STOPPING`
`boolean`	`isUnknown()` Returns true if the current state is `UNKNOWN`
`void`	`set(int state, WZError error)` Update the property values of this instance with the specified values
`void`	`set(WZStatus other)` Update the property values of this instance with the property values from the specified instance
`int`	`setAndWaitForState(int state, int desiredState)` Updates the value of the state property and waits for the state to transition to another value.
`void`	`setError(WZError other)` Sets the last error property values using the property values from the specified instance
`void`	`setState(int state)` Set the value of the state property
`String`	`toString()`
`int`	`waitForState(int desiredState)` Wait until the value of the state property is equal to the specified value or `WZState.IDLE`

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

- Constructor Detail
  - WZStatus
```
public WZStatus()
```
    The default constructor
  - WZStatus
```
public WZStatus(int state,
                WZError error)
```
    Construct a new instance using the specified property values
    
    Parameters:
    
    state - The value for state property
    
    error - An instance used to initialize the last error property
  - WZStatus
```
public WZStatus(int state)
```
    Construct a new instance using the specified property values
    
    Parameters:
    
    state - The value for state property
  - WZStatus
```
public WZStatus(WZStatus other)
```
    Construct a new instance using the property values from the specified instance
    
    Parameters:
    
    other - The instance to replicate
- Method Detail
  - getState
```
public int getState()
```
    Returns the value of the state property
    
    Returns:
    
    The state value
  - setState
```
public void setState(int state)
```
    Set the value of the state property
    
    Parameters:
    
    state - The value for state property
  - getLastError
```
public WZError getLastError()
```
    Returns the last error reported
    
    Returns:
    
    the last error reported
  - getLastError
```
public WZError getLastError(boolean clear)
```
    Returns the last error reported and clears the last error property
    
    Returns:
    
    the last error reported
  - setError
```
public void setError(WZError other)
```
    Sets the last error property values using the property values from the specified instance
    
    Parameters:
    
    other - The instance to replicate
  - clearLastError
```
public WZError clearLastError()
```
    Clear the value of the last error property, leaving the state as is
    
    Returns:
    
    The value of the last error property before it was cleared
  - clearLastError
```
public WZError clearLastError(int newState)
```
    Clear the value of the last error property and sets the state to the specified value
    
    Parameters:
    
    newState - The new state value
    
    Returns:
    
    The value of the last error property before it was cleared
  - set
```
public void set(int state,
                WZError error)
```
    Update the property values of this instance with the specified values
    
    Parameters:
    
    state - The value for state property
    
    error - An instance used to initialize the last error property
  - set
```
public void set(WZStatus other)
```
    Update the property values of this instance with the property values from the specified instance
    
    Parameters:
    
    other - The instance with the property values to replicate
  - setAndWaitForState
```
public int setAndWaitForState(int state,
                              int desiredState)
```
    Updates the value of the state property and waits for the state to transition to another value.
    An example use of this method is to update the value of the state property which causes an asynchronous task to complete and update the value of the state property itself.
    
    Parameters:
    
    state - The value for state property
    
    desiredState - The state property value to wait for
    
    Returns:
    
    The value of the state property after waiting has terminated
    
    See Also:
    
    waitForState(int)
  - waitForState
```
public int waitForState(int desiredState)
```
    Wait until the value of the state property is equal to the specified value or WZState.IDLE
    An example use of this method is to wait on an asynchronous task to complete and update the value of the state property.
    
    Parameters:
    
    desiredState - The state property value to wait for
    
    Returns:
    
    The value of the state property after waiting has terminated
    
    See Also:
    
    waitForState(int)
  - isIdle
```
public boolean isIdle()
```
    Returns true if the current state is IDLE
    
    Returns:
    
    true if the current state is WZState.IDLE false otherwise
  - isStarting
```
public boolean isStarting()
```
    Returns true if the current state is STARTING
    
    Returns:
    
    true if the current state is WZState.STARTING false otherwise
  - isReady
```
public boolean isReady()
```
    Returns true if the current state is READY
    
    Returns:
    
    true if the current state is WZState.READY false otherwise
  - isRunning
```
public boolean isRunning()
```
    Returns true if the current state is RUNNING
    
    Returns:
    
    true if the current state is WZState.RUNNING false otherwise
  - isPaused
```
public boolean isPaused()
```
    Returns true if the current state is PAUSED
    
    Returns:
    
    true if the current state is WZState.PAUSED false otherwise
  - isStopping
```
public boolean isStopping()
```
    Returns true if the current state is STOPPING
    
    Returns:
    
    true if the current state is WZState.STOPPING false otherwise
  - isStopped
```
public boolean isStopped()
```
    Returns true if the current state is STOPPED
    
    Returns:
    
    true if the current state is WZState.STOPPED false otherwise
  - isComplete
```
public boolean isComplete()
```
    Returns true if the current state is COMPLETE
    
    Returns:
    
    true if the current state is WZState.COMPLETE false otherwise
  - isShutdown
```
public boolean isShutdown()
```
    Returns true if the current state is SHUTDOWN
    
    Returns:
    
    true if the current state is WZState.SHUTDOWN false otherwise
  - isUnknown
```
public boolean isUnknown()
```
    Returns true if the current state is UNKNOWN
    
    Returns:
    
    true if the current state is WZState.UNKNOWN false otherwise
  - isBuffering
```
public boolean isBuffering()
```
    Returns true if the current state is PREBUFFERING_STARTED
    
    Returns:
    
    true if the current state is WZState.PREBUFFERING_STARTED false otherwise
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WZStatus

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WZStatus

WZStatus

WZStatus

WZStatus

Method Detail

getState

setState

getLastError

getLastError

setError

clearLastError

clearLastError

set

set

setAndWaitForState

waitForState

isIdle

isStarting

isReady

isRunning

isPaused

isStopping

isStopped

isComplete

isShutdown

isUnknown

isBuffering

toString