ZFFramework
 
Loading...
Searching...
No Matches
ZFProtocolZFAudio.h
Go to the documentation of this file.
1
5
6#ifndef _ZFI_ZFProtocolZFAudio_h_
7#define _ZFI_ZFProtocolZFAudio_h_
8
9#include "ZFCore/ZFProtocol.h"
10#include "../ZFAudio.h"
11ZF_NAMESPACE_GLOBAL_BEGIN
12
16ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_ZFUIKit, ZFAudio)
17public:
19 virtual void *nativeAudioCreate(ZF_IN ZFAudio *audio) zfpurevirtual;
21 virtual void nativeAudioDestroy(ZF_IN ZFAudio *audio) zfpurevirtual;
22
24 virtual void nativeAudioLoad(
25 ZF_IN ZFAudio *audio
26 , ZF_IN const ZFInput &input
27 ) zfpurevirtual;
29 virtual void nativeAudioLoadCancel(ZF_IN ZFAudio *audio) zfpurevirtual;
30
32 virtual void nativeAudioStart(ZF_IN ZFAudio *audio) zfpurevirtual;
34 virtual void nativeAudioStop(ZF_IN ZFAudio *audio) zfpurevirtual;
36 virtual void nativeAudioResume(ZF_IN ZFAudio *audio) zfpurevirtual;
38 virtual void nativeAudioPause(ZF_IN ZFAudio *audio) zfpurevirtual;
39
41 virtual zftimet nativeAudioDuration(ZF_IN ZFAudio *audio) zfpurevirtual;
43 virtual zftimet nativeAudioPosition(ZF_IN ZFAudio *audio) zfpurevirtual;
45 virtual void nativeAudioPosition(
46 ZF_IN ZFAudio *audio
47 , ZF_IN zftimet position
48 ) zfpurevirtual;
49
51 virtual void nativeAudioVolume(
52 ZF_IN ZFAudio *audio
53 , ZF_IN zffloat volume
54 ) zfpurevirtual;
55
56public:
60 zffinal void notifyAudioOnLoad(
61 ZF_IN ZFAudio *audio
62 , ZF_IN zfbool success
63 , ZF_IN v_zfstring *errorHint
64 );
68 zffinal void notifyAudioOnStop(
69 ZF_IN ZFAudio *audio
70 , ZF_IN zfbool success
71 , ZF_IN v_zfstring *errorHint
72 );
77 zffinal void notifyAudioOnResume(ZF_IN ZFAudio *audio);
81 zffinal void notifyAudioOnPause(ZF_IN ZFAudio *audio);
82ZFPROTOCOL_INTERFACE_END(ZFAudio)
83
84ZF_NAMESPACE_GLOBAL_END
85#endif // #ifndef _ZFI_ZFProtocolZFAudio_h_
86
ZFAudio.h
audio player
zffinal
#define zffinal
dummy macro shows that a method or class is designed must not to be overrided
Definition ZFCoreTypeDef_ClassType.h:63
zfpurevirtual
#define zfpurevirtual
dummy macro shows that a method is pure virtual method
Definition ZFCoreTypeDef_ClassType.h:68
ZF_IN
#define ZF_IN
dummy macro that shows the param used as required input
Definition ZFCoreTypeDef_ClassType.h:184
zfbool
_ZFT_t_zfbool zfbool
bool type
Definition ZFCoreTypeDef_CoreType.h:103
zftimet
_zft_zftimet zftimet
time unit, ensured at least 64 bit, ensured signed
Definition ZFCoreTypeDef_CoreType.h:203
zffloat
_zft_zffloat zffloat
same as float, see zfindex
Definition ZFCoreTypeDef_CoreType.h:183
ZF_NAMESPACE_GLOBAL_BEGIN
#define ZF_NAMESPACE_GLOBAL_BEGIN
begin namespace ZFFramework
Definition ZFNamespace.h:97
ZF_NAMESPACE_GLOBAL_END
#define ZF_NAMESPACE_GLOBAL_END
end namespace ZFFramework
Definition ZFNamespace.h:98
ZFProtocol.h
protocol definitions for ZFFramework
ZFPROTOCOL_INTERFACE_END
#define ZFPROTOCOL_INTERFACE_END(ModuleName)
for more information, please refer to ZFPROTOCOL_INTERFACE_BEGIN
Definition ZFProtocol.h:413
ZFPROTOCOL_INTERFACE_BEGIN
#define ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_, ModuleName)
declare a protocol interface for ZFFramework
Definition ZFProtocol.h:407
ZFLIB_ZFUIKit
#define ZFLIB_ZFUIKit
used to export symbols
Definition ZFUIKitDef.h:16
ZFAudio
audio player
Definition ZFAudio.h:25
ZFInput
general input callback
Definition ZFIOCallback_input.h:36
ZFPInterface_ZFAudio::notifyAudioOnResume
void notifyAudioOnResume(ZFAudio *audio)
implementation must notify when audio start success and about to play, or resume from pause
ZFPInterface_ZFAudio::nativeAudioCreate
virtual void * nativeAudioCreate(ZFAudio *audio)=0
create native audio
ZFPInterface_ZFAudio::notifyAudioOnStop
void notifyAudioOnStop(ZFAudio *audio, zfbool success, v_zfstring *errorHint)
implementation must notify when audio play success or fail
ZFPInterface_ZFAudio::nativeAudioStop
virtual void nativeAudioStop(ZFAudio *audio)=0
stop native audio, ensured called after loaded success and started
ZFPInterface_ZFAudio::nativeAudioPosition
virtual zftimet nativeAudioPosition(ZFAudio *audio)=0
get native audio position
ZFPInterface_ZFAudio::notifyAudioOnPause
void notifyAudioOnPause(ZFAudio *audio)
implementation must notify when audio paused
ZFPInterface_ZFAudio::nativeAudioDestroy
virtual void nativeAudioDestroy(ZFAudio *audio)=0
destroy native audio
ZFPInterface_ZFAudio::nativeAudioResume
virtual void nativeAudioResume(ZFAudio *audio)=0
resume native audio, ensured called after loaded success and paused
ZFPInterface_ZFAudio::nativeAudioLoadCancel
virtual void nativeAudioLoadCancel(ZFAudio *audio)=0
cancel load native audio
ZFPInterface_ZFAudio::notifyAudioOnLoad
void notifyAudioOnLoad(ZFAudio *audio, zfbool success, v_zfstring *errorHint)
implementation must notify when audio load success or fail
ZFPInterface_ZFAudio::nativeAudioStart
virtual void nativeAudioStart(ZFAudio *audio)=0
start native audio, ensured called after loaded success
ZFPInterface_ZFAudio::nativeAudioPause
virtual void nativeAudioPause(ZFAudio *audio)=0
pause native audio, ensured called after loaded success and started
ZFPInterface_ZFAudio::nativeAudioVolume
virtual void nativeAudioVolume(ZFAudio *audio, zffloat volume)=0
set native audio volume
ZFPInterface_ZFAudio::nativeAudioDuration
virtual zftimet nativeAudioDuration(ZFAudio *audio)=0
get native audio duration
ZFPInterface_ZFAudio::nativeAudioLoad
virtual void nativeAudioLoad(ZFAudio *audio, const ZFInput &input)=0
load native audio from input
ZFPInterface_ZFAudio::nativeAudioPosition
virtual void nativeAudioPosition(ZFAudio *audio, zftimet position)=0
set native audio position
v_zfstring
type wrapper for ZFTypeId::Value
Definition ZFTypeId_CoreType.h:194