public class WOWZStatus
extends java.lang.Object
Constructor and Description |
---|
WOWZStatus()
The default constructor.
|
WOWZStatus(int state)
Creates and initializes an instance using the specified property values.
|
WOWZStatus(int state,
WOWZError error)
Creates and initializes an instance using the specified property values.
|
WOWZStatus(WOWZStatus other)
Creates and initializes an instance using the property values from the specified instance.
|
Modifier and Type | Method and Description |
---|---|
WOWZError |
clearLastError()
Clears the last error property, leaving the state as is.
|
WOWZError |
clearLastError(int newState)
Clears the value of the last error property and sets the state to the specified value.
|
WOWZError |
getLastError()
Gets the last reported error.
|
WOWZError |
getLastError(boolean clear)
Gets the last reported error and clears the last error property.
|
int |
getState()
Gets the state property.
|
boolean |
isBuffering()
Checks whether the current state is "prebuffering started."
|
boolean |
isComplete()
Checks whether the current state is "complete."
|
boolean |
isIdle()
Checks whether the current state is "idle."
|
boolean |
isPaused()
Checks whether the current state is "paused."
|
boolean |
isReady()
Checks whether the current state is "ready."
|
boolean |
isRunning()
Checks whether the current state is "running."
|
boolean |
isShutdown()
Checks whether the current state is "shutdown.""
|
boolean |
isStarting()
Checks whether the current state is "starting."
|
boolean |
isStopped()
Checks whether the current state is "stopped."
|
boolean |
isStopping()
Checks whether the current state is "stopping."
|
boolean |
isUnknown()
Checks whether the current state is "unknown."
|
void |
set(int state,
WOWZError error)
Updates the property values of this instance with the specified values.
|
void |
set(WOWZStatus other)
Updates 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(WOWZError other)
Sets the last error property values using the property values from the specified instance.
|
void |
setState(int state)
Sets the state property.
|
java.lang.String |
toString() |
int |
waitForState(int desiredState)
Waits until the value of the state property is equal to the specified value or
WOWZState.IDLE . |
public WOWZStatus()
public WOWZStatus(int state, WOWZError error)
state
- The value for state property.error
- An instance used to initialize the last error property.public WOWZStatus(int state)
state
- The value for state property.public WOWZStatus(WOWZStatus other)
other
- The instance to use.public int getState()
public void setState(int state)
state
- The value for state property.public WOWZError getLastError()
public WOWZError getLastError(boolean clear)
public void setError(WOWZError other)
other
- The instance to use.public WOWZError clearLastError()
public WOWZError clearLastError(int newState)
newState
- The new state.public void set(int state, WOWZError error)
state
- The value for state property.error
- An instance used to initialize the last error property.public void set(WOWZStatus other)
other
- The instance with the property values to use.public int setAndWaitForState(int state, int desiredState)
You might use this method to update the value of the state property which causes an asynchronous task to complete and update the value of the state property itself.
state
- The value for state property.desiredState
- The state property value to wait for.waitForState(int)
public int waitForState(int desiredState)
WOWZState.IDLE
.
You might use this method to wait on an asynchronous task to complete and update the value of the state property.
desiredState
- The state property value to wait for.waitForState(int)
public boolean isIdle()
WOWZState.IDLE
; false otherwise.public boolean isStarting()
WOWZState.STARTING
; false otherwise.public boolean isReady()
WOWZState.READY
; false otherwise.public boolean isRunning()
WOWZState.RUNNING
; false otherwise.public boolean isPaused()
WOWZState.PAUSED
; false otherwise.public boolean isStopping()
WOWZState.STOPPING
; false otherwise.public boolean isStopped()
WOWZState.STOPPED
; false otherwise.public boolean isComplete()
WOWZState.COMPLETE
; false otherwise.public boolean isShutdown()
WOWZState.SHUTDOWN
; false otherwise.public boolean isUnknown()
WOWZState.UNKNOWN
; false otherwise.public boolean isBuffering()
WOWZState.PREBUFFERING_STARTED
; false otherwise.public java.lang.String toString()
toString
in class java.lang.Object
© 2016 - 2018 Wowza Media Systems, LLC. All rights reserved. Terms | Privacy | Trademarks | Legal