WOWZBroadcastStatus

Conforms to:
NSMutableCopying, NSCopying
Superclass:
NSObject
Declared In:

Introduction

WOWZBroadcastStatus is a thread-safe class for working with SDK component state and error properties. Client applications typically don't have any need for creating a WOWZBroadcastStatus object.



Methods

-initWithEvent:
-initWithState:
-initWithState:event:
-initWithStateAndError:aError:
-resetStatus
-resetStatusWithState:
+statusWithEvent:
+statusWithState:
+statusWithState:event:
+statusWithStateAndError:aError:

initWithEvent:


- (nonnull instancetype) initWithEvent:(WOWZBroadcastEvent)event; 
Parameters
event

The WOWZBroadcastEvent to use to initialize the object.

Return Value

An initialized WOWZBroadcastStatus object.

Discussion

Initializes a WOWZBroadcastStatus object with a specified event.


initWithState:


- (nonnull instancetype) initWithState:(WOWZBroadcastState)aState; 
Parameters
aState

The state to use to initialize the object.

Return Value

An initialized WOWZBroadcastStatus object.

Discussion

Initializes a WOWZBroadcastStatus object with a specified state.


initWithState:event:


- (nonnull instancetype) initWithState:(WOWZBroadcastState)aState 
        event:(WOWZBroadcastEvent)event; 
Parameters
aState

The state to use to initialize the object.

event

The WOWZBroadcastEvent to use to initialize the object.

Return Value

An initialized WOWZBroadcastStatus object.

Discussion

Initializes a WOWZBroadcastStatus object with a specified state and event.


initWithStateAndError:aError:


- (nonnull instancetype) initWithStateAndError:(WOWZBroadcastState)aState 
        aError:(nonnull NSError *)aError; 
Parameters
aState

The state to use to initialize the object.

aError

The error to use to initialize the object.

Return Value

An initialized WOWZBroadcastStatus object.

Discussion

Initializes a WOWZBroadcastStatus object with a specified state and error.


resetStatus


- (void) resetStatus; 
Discussion

Reinitializes a WOWZBroadcastStatus object, clearing all errors, events, and data values and setting the state to WOWZBroadcastStateIdle.


resetStatusWithState:


Parameters
aState

The state to use to initialize the object.

Discussion

Reinitializes a WOWZBroadcastStatus object, clearing all errors, events, and data values and setting the state to the specified value.


statusWithEvent:


+ (nonnull instancetype) statusWithEvent:(WOWZBroadcastEvent)event; 
Parameters
event

The WOWZBroadcastEvent to use to initialize the object.

Return Value

An initialized WOWZBroadcastStatus object.

Discussion

Returns a WOWZBroadcastStatus object with a specified event.


statusWithState:


+ (nonnull instancetype) statusWithState:(WOWZBroadcastState)aState; 
Parameters
aState

The state to use to initialize the object.

Return Value

An initialized WOWZBroadcastStatus object.

Discussion

Returns a WOWZBroadcastStatus object with a specified state.


statusWithState:event:


+ (nonnull instancetype) statusWithState:(WOWZBroadcastState)aState 
        event:(WOWZBroadcastEvent)event; 
Parameters
aState

The state to use to initialize the object.

event

The WOWZBroadcastEvent to use to initialize the object.

Return Value

An initialized WOWZBroadcastStatus object.

Discussion

Returns a WOWZBroadcastStatus object with a specified state and event.


statusWithStateAndError:aError:


+ (nonnull instancetype) statusWithStateAndError:(WOWZBroadcastState)aState 
        aError:(nonnull NSError *)aError; 
Parameters
aState

The state to use to initialize the object.

aError

The error to use to initialize the object.

Return Value

An initialized WOWZBroadcastStatus object.

Discussion

Returns a WOWZBroadcastStatus object with a specified state and error.


Typedefs

NS_ENUM
NS_ENUM
WOWZBroadcastEvent
WOWZBroadcastState

NS_ENUM


private

typedef NS_ENUM(NSUInteger, WOWZBroadcastState) { WOWZBroadcastStateIdle = 0, WOWZBroadcastStateReady, WOWZBroadcastStateBroadcasting };
Constants
WOWZBroadcastStateIdle

The broadcasting component or session is idle.

WOWZBroadcastStateReady

The broadcasting component or session is ready or has been initialized.

WOWZBroadcastStateBroadcasting

The broadcasting component or session is broadcasting.

Discussion

A collection of constants that describe the state of the broadcasting component or session.

See Also


NS_ENUM


private

typedef NS_ENUM(NSUInteger, WOWZBroadcastEvent) { WOWZBroadcastEventNone = 0, WOWZBroadcastEventLowBandwidth, WOWZBroadcastEventBitrateReduced, WOWZBroadcastEventBitrateIncreased, WOWZBroadcastEventEncoderPaused, WOWZBroadcastEventEncoderResumed };
Constants
WOWZBroadcastEventNone

No event.

WOWZBroadcastEventLowBandwidth

If network bandwidth is insufficient for the specified video-broadcast settings, the encoder may attempt to compensate by sending a reduced bitrate or frame rate.

WOWZBroadcastEventBitrateReduced

Sent when the encoder reduces the stream bitrate to compensate for low-bandwidth conditions. Changing the bitrate adds WOWZBroadcastStatusNewBitrateKey and WOWZBroadcastStatusPreviousBitrateKey, represented as NSNumber values, to the WOWZBroadcastStatus class data dictionary.

WOWZBroadcastEventBitrateIncreased

Sent when the encoder increases the bitrate after having previously reduced it. The bitrate will never increase beyond the original bitrate specified in the configuration settings for the streaming session. Changing the bitrate adds WOWZBroadcastStatusNewBitrateKey and WOWZBroadcastStatusPreviousBitrateKey, represented as NSNumber values, to the WOWZBroadcastStatus class data dictionary.

WOWZBroadcastEventEncoderPaused

Sent when the encoder stops sending frames and waits for queued frames to catch up. Typically, the encoder pauses while it's reducing the bitrate to compensate for constrained network bandwidth.

WOWZBroadcastEventEncoderResumed

Sent when a previously paused encoder resumes.

Discussion

A collection of constants that describe the component event.

See Also


WOWZBroadcastEvent


private

typedef NS_ENUM(NSUInteger, WOWZBroadcastEvent) { WOWZBroadcastEventNone = 0, WOWZBroadcastEventLowBandwidth, WOWZBroadcastEventBitrateReduced, WOWZBroadcastEventBitrateIncreased, WOWZBroadcastEventEncoderPaused, WOWZBroadcastEventEncoderResumed };
Constants
WOWZBroadcastEventNone

No event.

WOWZBroadcastEventLowBandwidth

If network bandwidth is insufficient for the specified video-broadcast settings, the encoder may attempt to compensate by sending a reduced bitrate or frame rate.

WOWZBroadcastEventBitrateReduced

Sent when the encoder reduces the stream bitrate to compensate for low-bandwidth conditions. Changing the bitrate adds WOWZBroadcastStatusNewBitrateKey and WOWZBroadcastStatusPreviousBitrateKey, represented as NSNumber values, to the WOWZBroadcastStatus class data dictionary.

WOWZBroadcastEventBitrateIncreased

Sent when the encoder increases the bitrate after having previously reduced it. The bitrate will never increase beyond the original bitrate specified in the configuration settings for the streaming session. Changing the bitrate adds WOWZBroadcastStatusNewBitrateKey and WOWZBroadcastStatusPreviousBitrateKey, represented as NSNumber values, to the WOWZBroadcastStatus class data dictionary.

WOWZBroadcastEventEncoderPaused

Sent when the encoder stops sending frames and waits for queued frames to catch up. Typically, the encoder pauses while it's reducing the bitrate to compensate for constrained network bandwidth.

WOWZBroadcastEventEncoderResumed

Sent when a previously paused encoder resumes.

Discussion

A collection of constants that describe the component event.

See Also


WOWZBroadcastState


private

typedef NS_ENUM(NSUInteger, WOWZBroadcastState) { WOWZBroadcastStateIdle = 0, WOWZBroadcastStateReady, WOWZBroadcastStateBroadcasting };
Constants
WOWZBroadcastStateIdle

The broadcasting component or session is idle.

WOWZBroadcastStateReady

The broadcasting component or session is ready or has been initialized.

WOWZBroadcastStateBroadcasting

The broadcasting component or session is broadcasting.

Discussion

A collection of constants that describe the state of the broadcasting component or session.

See Also


Properties

data
error
event
hasError
isBroadcasting
isIdle
isReady
state

data


@property (nonatomic,
    strong,
    nullable) NSDictionary * data; 
Discussion

Data related to the status. May be null.


error


@property (nonatomic,
    strong,
    nullable) NSError * error; 
Discussion

The last error reported by the broadcast session.


event


@property (nonatomic) WOWZBroadcastEvent event; 
Discussion

The event used by the broadcast session.


hasError


@property (readonly,
    nonatomic) BOOL hasError; 
Return Value

True if the error is non-null; false otherwise.

Discussion

See if the error is non-null.


isBroadcasting


@property (readonly,
    nonatomic) BOOL isBroadcasting; 
Return Value

True if the state is WOWZBroadcastStateBroadcasting; false otherwise.

Discussion

See if the state equals WOWZBroadcastStateBroadcasting.


isIdle


@property (readonly,
    nonatomic) BOOL isIdle; 
Return Value

True if the state is WOWZBroadcastStateIdle; false otherwise.

Discussion

See if the state equals WOWZBroadcastStateIdle.


isReady


@property (readonly,
    nonatomic) BOOL isReady; 
Return Value

True if the state is WOWZBroadcastStateReady; false otherwise.

Discussion

See if the state equals WOWZBroadcastStateReady.


state


@property (nonatomic) WOWZBroadcastState state; 
Discussion

The state of the broadcast session.