Inherits from NSObject
Declared in BZMediaParams.h

Overview

This interface describes the parameters for audio playback.

A BZAudioPlayParams object can be created as follows:

BZAudioPlayParams* bzAudioPlayParams = [[BZAudioPlayParams alloc] init];

Swift
let bzAudioPlayParams = BZAudioPlayParams()

Tasks

  •   m_bLoop

    Specifies whether the audio segmant playback will loop indefinitley until client sends a request to stop audio playback. Only valid for audio playback of recorded audio files. Does not apply to audio playback of speech synthesis. Default: FALSE.

           property
  •   m_fVolumeScaling

    The volume scaling of the audio playback. Default: 1.0.

           property
  •   m_nStartPlayPosMs

    The timestamp when audio playback will start playing an audio segment from. Default: 0 to start audio playback from beginning of the audio segment.

           property
  •   m_nStopPlayPosMs

    The timestamp when audio playback will stop playing an audio segment at. Default: 0 to continue audio playback to the end of the audio segment.

           property
  •   m_nNotificationMs

    The bookmark timestamp in milliseconds when client will be notified when audio playback reaches the bookmark in an audio segment. Default: 0 reflects no bookmark is set.

           property
  •   m_eAudioFormat

    The audio format as defined in BZAudioFormat. Default: BZAudioFormat:AF_MEDIA.

           property
  •   m_AudioCodec

    The audio codec as defined in BZAudioCodec. Default: nil.

           property
  •   m_SSEngineParams

    The speech synthesizer engine parameters as defined in BZSSEngineParams. Default: nil.

           property
  •   m_SSRecordParams

    The parameters for recording synthesized audio to a file. Default: nil.

           property

Properties

m_AudioCodec

@property BZAudioCodec *m_AudioCodec

Discussion

The audio codec as defined in BZAudioCodec. Default: nil.

Declared In

BZMediaParams.h

m_SSEngineParams

@property BZSSEngineParams *m_SSEngineParams

Discussion

The speech synthesizer engine parameters as defined in BZSSEngineParams. Default: nil.

Declared In

BZMediaParams.h

m_SSRecordParams

@property BZSSRecordParams *m_SSRecordParams

Discussion

The parameters for recording synthesized audio to a file. Default: nil.

Declared In

BZMediaParams.h

m_bLoop

@property BOOL m_bLoop

Discussion

Specifies whether the audio segmant playback will loop indefinitley until client sends a request to stop audio playback. Only valid for audio playback of recorded audio files. Does not apply to audio playback of speech synthesis. Default: FALSE.

Declared In

BZMediaParams.h

m_eAudioFormat

@property BZAudioFormat m_eAudioFormat

Discussion

The audio format as defined in BZAudioFormat. Default: BZAudioFormat:AF_MEDIA.

Declared In

BZMediaParams.h

m_fVolumeScaling

@property float m_fVolumeScaling

Discussion

The volume scaling of the audio playback. Default: 1.0.

Declared In

BZMediaParams.h

m_nNotificationMs

@property int m_nNotificationMs

Discussion

The bookmark timestamp in milliseconds when client will be notified when audio playback reaches the bookmark in an audio segment. Default: 0 reflects no bookmark is set.

Declared In

BZMediaParams.h

m_nStartPlayPosMs

@property int m_nStartPlayPosMs

Discussion

The timestamp when audio playback will start playing an audio segment from. Default: 0 to start audio playback from beginning of the audio segment.

Declared In

BZMediaParams.h

m_nStopPlayPosMs

@property int m_nStopPlayPosMs

Discussion

The timestamp when audio playback will stop playing an audio segment at. Default: 0 to continue audio playback to the end of the audio segment.

Declared In

BZMediaParams.h