ZFFramework
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | List of all members
ZFPInterface_ZFAudio Class Referenceabstract

protocol for ZFAudio More...

#include <ZFProtocolZFAudio.h>

Inheritance diagram for ZFPInterface_ZFAudio:
ZFProtocol

Public Member Functions

virtual const zfchar * protocolName (void) const
 get the name of the protocol module, e.g. "ZFObject"
 
virtual void * nativeAudioCreate (ZFAudio *audio)=0
 create native audio
 
virtual void nativeAudioDestroy (ZFAudio *audio)=0
 destroy native audio
 
virtual void nativeAudioLoad (ZFAudio *audio, const ZFInput &input)=0
 load native audio from input
 
virtual void nativeAudioLoadCancel (ZFAudio *audio)=0
 cancel load native audio
 
virtual void nativeAudioStart (ZFAudio *audio)=0
 start native audio, ensured called after loaded success
 
virtual void nativeAudioStop (ZFAudio *audio)=0
 stop native audio, ensured called after loaded success and started
 
virtual void nativeAudioResume (ZFAudio *audio)=0
 resume native audio, ensured called after loaded success and paused
 
virtual void nativeAudioPause (ZFAudio *audio)=0
 pause native audio, ensured called after loaded success and started
 
virtual zftimet nativeAudioDuration (ZFAudio *audio)=0
 get native audio duration
 
virtual zftimet nativeAudioPosition (ZFAudio *audio)=0
 get native audio position
 
virtual void nativeAudioPosition (ZFAudio *audio, zftimet position)=0
 set native audio position
 
virtual void nativeAudioVolume (ZFAudio *audio, zffloat volume)=0
 set native audio volume
 
void notifyAudioOnLoad (ZFAudio *audio, zfbool success, v_zfstring *errorHint)
 implementation must notify when audio load success or fail
 
void notifyAudioOnStop (ZFAudio *audio, zfbool success, v_zfstring *errorHint)
 implementation must notify when audio play success or fail
 
void notifyAudioOnResume (ZFAudio *audio)
 implementation must notify when audio start success and about to play, or resume from pause
 
void notifyAudioOnPause (ZFAudio *audio)
 implementation must notify when audio paused
 
- Public Member Functions inherited from ZFProtocol
virtual void protocolOnInit (void)
 called to init the protocol
 
virtual void protocolOnInitFinish (void)
 see protocolOnInit
 
virtual void protocolOnDeallocPrepare (void)
 see protocolOnInit
 
virtual void protocolOnDealloc (void)
 see protocolOnInit
 
virtual ZFProtocolInstanceState protocolInstanceState (void)
 protocol instance's state
 
virtual const zfchar * protocolImplName (void) const
 get the name of the protocol implementation, e.g. "ZFObject_default"
 
virtual ZFProtocolLevel protocolImplLevel (void) const
 get the level of the protocol implementation
 
virtual const zfchar * protocolImplPlatformHint (void) const
 get type hint of the implementation or empty string if not defined, e.g. "iOS:NSString" for iOS's string impl, use ZFPROTOCOL_IMPLEMENTATION_PLATFORM_HINT to register
 
virtual void objectInfoT (zfstring &ret) const
 see objectInfo
 
virtual zfstring objectInfo (void) const
 get a short info about this object
 

Protected Types

typedef ZFProtocol zfsuper
 class ref to super
 
typedef ZFPInterface_ZFAudio zfself
 class ref to self
 

Detailed Description

protocol for ZFAudio

Member Function Documentation

◆ protocolName()

virtual const zfchar * ZFPInterface_ZFAudio::protocolName ( void ) const
inlinevirtual

get the name of the protocol module, e.g. "ZFObject"

Reimplemented from ZFProtocol.

The documentation for this class was generated from the following file: