WOWZStatus
IntroductionWOWZStatus 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 WOWZStatus object. Methods
initWithEvent:- (nonnull instancetype) initWithEvent:(WOWZEvent)event; ParametersReturn ValueAn initialized WOWZStatus object. DiscussionInitializes a WOWZStatus object with a specified event. initWithState:- (nonnull instancetype) initWithState:(WOWZState)aState; ParametersReturn ValueAn initialized WOWZStatus object. DiscussionInitializes a WOWZStatus object with a specified state. initWithState:event:- (nonnull instancetype) initWithState:(WOWZState)aState event:(WOWZEvent)event; ParametersReturn ValueAn initialized WZStatus object. DiscussionInitializes a WOWZStatus object with a specified state and event. initWithStateAndError:aError:- (nonnull instancetype) initWithStateAndError:(WOWZState)aState aError:(nonnull NSError *)aError; ParametersReturn ValueAn initialized WOWZStatus object. DiscussionInitializes a WOWZStatus object with a specified state and error. resetStatus- (void) resetStatus; DiscussionReinitializes a WOWZStatus object, clearing all errors, events, and data values and setting the state to WOWZStateIdle. resetStatusWithState:- (void) resetStatusWithState:(WOWZState)aState; ParametersDiscussionReinitializes a WOWZStatus object, clearing all errors, events, and data values and setting the state to the specified value. statusWithEvent:+ (nonnull instancetype) statusWithEvent:(WOWZEvent)event; ParametersReturn ValueAn initialized WOWZStatus object. DiscussionReturns a WOWZStatus object with a specified event. statusWithState:+ (nonnull instancetype) statusWithState:(WOWZState)aState; ParametersReturn ValueAn initialized WOWZStatus object. DiscussionReturns a WOWZStatus object with a specified state. statusWithState:event:+ (nonnull instancetype) statusWithState:(WOWZState)aState event:(WOWZEvent)event; ParametersReturn ValueAn initialized WOWZStatus object. DiscussionReturns a WOWZStatus object with a specified state and event. statusWithStateAndError:aError:+ (nonnull instancetype) statusWithStateAndError:(WOWZState)aState aError:(nonnull NSError *)aError; ParametersReturn ValueAn initialized WOWZStatus object. DiscussionReturns a WOWZStatus object with a specified state and error. TypedefsNS_ENUMprivate Constants
DiscussionA collection of constants that describe the state of the broadcasting component or session. See Also NS_ENUMprivate Constants
DiscussionA collection of constants that describe the component event. See Also WOWZEventprivate Constants
DiscussionA collection of constants that describe the component event. See Also WOWZStateprivate Constants
DiscussionA collection of constants that describe the state of the broadcasting component or session. See Also Propertiesdata@property (nonatomic, strong, nullable) NSDictionary * data; DiscussionData related to the status. May be null. error@property (nonatomic, strong, nullable) NSError * error; DiscussionThe last error reported by the broadcast session. event@property (nonatomic) WOWZEvent event; DiscussionThe event used by the broadcast session. hasError@property (readonly, nonatomic) BOOL hasError; Return ValueTrue if the error is non-null; false otherwise. DiscussionSee if the error is non-null. isIdle@property (readonly, nonatomic) BOOL isIdle; Return ValueTrue if the state is WOWZStateIdle; false otherwise. DiscussionSee if the state equals WOWZStateIdle. isReady@property (readonly, nonatomic) BOOL isReady; Return ValueTrue if the state is WOWZStateReady; false otherwise. DiscussionSee if the state equals WOWZStateReady. isRunning@property (readonly, nonatomic) BOOL isRunning; Return ValueTrue if the state is WOWZStateRunning; false otherwise. DiscussionSee if the state equals WOWZStateRunning. isStarting@property (readonly, nonatomic) BOOL isStarting; Return ValueTrue if the state is WOWZStateStarting; false otherwise. DiscussionSee if the state equals WOWZStateStarting. ` isStopping@property (readonly, nonatomic) BOOL isStopping; Return ValueTrue if the state is WOWZStateStopping; false otherwise. DiscussionSee if the state equals WOWZStateStopping. state@property (nonatomic) WOWZState state; DiscussionThe state of the broadcast session. |