Inherits from NSObject
Declared in BZMediaParams.h

Overview

This interface exposes the methods in order to translate media enumerated parameters or constants to their textual representation or better visibiliy, logging and debugging. BZMediaParams methods are all static and are accessed directly through BZMediaParams wthout the need to create on object of the interface. For example, the following functions return the string “NMF_PLAY_AUDIO”:

NSString* mediaFunction = [BZMediaParams ForBZNotifyMediaFunction:NMF_PLAY_AUDIO];

Swift
let mediaFunction = BZMediaParams.ForBZNotifyMediaFunction(NMF_PLAY_AUDIO)

Tasks

Class Methods

ForBZAudioPlayerState:

+ (NSString *)ForBZAudioPlayerState:(BZAudioPlayerState)audioPlayerState

Discussion

Method to translate a BZAudioPlayerState enumerated constant to its textual representation.

Parameters

audioPlayerState

The audio player state as defined in BZAudioPlayerState.

Return Value

The textual representation of audio player state.

Declared In

BZMediaParams.h

ForBZAudioRecorderState:

+ (NSString *)ForBZAudioRecorderState:(BZAudioRecorderState)audioRecorderState

Discussion

Method to translate a BZAudioRecorderState enumerated constant to its textual representation.

Parameters

audioRecorderState

The audio recorder state as defined in BZAudioRecorderState.

Return Value

The textual representation of audio recorder state.

Declared In

BZMediaParams.h

ForBZAudioSegmentType:

+ (NSString *)ForBZAudioSegmentType:(BZAudioSegmentType)audioSegmentType

Discussion

Method to translate a BZAudioSegmentType enumerated constant to its textual representation.

Parameters

audioSegmentType

The audio segment type as defined in BZAudioSegmentType.

Return Value

The textual representation of audio segment type.

Declared In

BZMediaParams.h

ForBZAudioSessionCategoryOption:

+ (NSString *)ForBZAudioSessionCategoryOption:(BZAudioSessionCategoryOption)audioSessionCategoryOption

Discussion

Method to translate a BZAudioSessionCategoryOption enumerated constant to its textual representation.

Parameters

audioSessionCategoryOption

The audio session category option as defined in BZAudioSessionCategoryOption.

Return Value

The textual representation of audio session category option.

Declared In

BZMediaParams.h

ForBZAudioSessionMode:

+ (NSString *)ForBZAudioSessionMode:(BZAudioSessionMode)audioSessionMode

Discussion

Method to translate a BZAudioSessionMode enumerated constant to its textual representation.

Parameters

audioSessionMode

The audio session mode as defined in BZAudioSessionMode.

Return Value

The textual representation of audio session mode.

Declared In

BZMediaParams.h

ForBZAudioSessionOutputRoute:

+ (NSString *)ForBZAudioSessionOutputRoute:(BZAudioSessionOutputRoute)audioSessionOutputRoute

Discussion

Method to translate a BZAudioSessionOutputRoute enumerated constant to its textual representation.

Parameters

audioSessionOutputRoute

The audio session output route as defined in BZAudioSessionOutputRoute.

Return Value

The textual representation of audio session output route.

Declared In

BZMediaParams.h

ForBZAudioSessionRouteChangeReason:

+ (NSString *)ForBZAudioSessionRouteChangeReason:(BZAudioSessionRouteChangeReason)audioSessionRouteChangeReason

Discussion

Method to translate a BZAudioSessionRouteChangeReason enumerated constant to its textual representation.

Parameters

audioSessionRouteChangeReason

The audio session route change reason as defined in BZAudioSessionRouteChangeReason.

Return Value

The textual representation of audio session route change reason.

Declared In

BZMediaParams.h

ForBZMediaStopRecordReason:

+ (NSString *)ForBZMediaStopRecordReason:(BZMediaStopRecordReason)mediaStopRecordReason

Discussion

Method to translate a BZMediaStopRecordReason enumerated constant to its textual representation.

Parameters

mediaStopRecordReason

The media stop record reason as defined in BZMediaStopRecordReason.

Return Value

The textual representation of media stop record reason.

Declared In

BZMediaParams.h

ForBZNotifyMediaEvent:

+ (NSString *)ForBZNotifyMediaEvent:(BZNotifyMediaEvent)mediaEvent

Discussion

Method to translate a BZNotifyMediaEvent enumerated constant to its textual representation.

Parameters

mediaEvent

The notify media event as defined in BZNotifyMediaEvent.

Return Value

The textual representation of notify media event .

Declared In

BZMediaParams.h

ForBZNotifyMediaFunction:

+ (NSString *)ForBZNotifyMediaFunction:(BZNotifyMediaFunction)mediaFunction

Discussion

Method to translate a BZNotifyMediaFunction enumerated constant to its textual representation.

Parameters

mediaFunction

The notify media function as defined in BZNotifyMediaFunction.

Return Value

The textual representation of notify media function.

Declared In

BZMediaParams.h

ForBZSREngineState:

+ (NSString *)ForBZSREngineState:(BZSREngineState)srEngineState

Discussion

Method to translate a BZSREngineState enumerated constant to its textual representation.

Parameters

srEngineState

The speech recognizer engine state as defined in BZSREngineState.

Return Value

The textual representation of speech recognizer engine state.

Declared In

BZMediaParams.h

ForBZSRResultStatusCode:

+ (NSString *)ForBZSRResultStatusCode:(BZSRResultStatusCode)srResutStatusCode

Discussion

Method to translate a BZSRResultStatusCode enumerated constant to its textual representation.

Parameters

srResutStatusCode

The speech recognition result status code as defined in BZSRResultStatusCode.

Return Value

The textual representation of speech recognition result status code.

Declared In

BZMediaParams.h

ForBZSRTaskType:

+ (NSString *)ForBZSRTaskType:(BZSRTaskType)taskType

Discussion

Method to translate a BZSRTaskType enumerated constant to its textual representation.

Parameters

taskType

The task type as defined in BZSRTaskType.

Return Value

The textual representation of task type.

Declared In

BZMediaParams.h

ForBZSSEngineState:

+ (NSString *)ForBZSSEngineState:(BZSSEngineState)ssEngineState

Discussion

Method to translate a BZSSEngineState enumerated constant to its textual representation.

Parameters

ssEngineState

The speech synthesizer engine state as defined in BZSSEngineState.

Return Value

The textual representation of speech synthesizer engine state.

Declared In

BZMediaParams.h