Open Reality Reference Guide
fbcameraswitcheraudiomanager.h
Go to the documentation of this file.
1 #ifndef __FBCAMERASWITCHERAUDIOMANAGER_H__
2 #define __FBCAMERASWITCHERAUDIOMANAGER_H__
3 /**************************************************************************
4 Copyright (c) 1994 - 2019 Autodesk, Inc. and/or its licensors.
5 All Rights Reserved.
6 
7 The coded instructions, statements, computer programs, and/or related
8 material (collectively the "Data") in these files contain unpublished
9 information proprietary to Autodesk, Inc. and/or its licensors, which is
10 protected by Canada and United States of America federal copyright law
11 and by international treaties.
12 
13 The Data may not be disclosed or distributed to third parties, in whole
14 or in part, without the prior written consent of Autodesk, Inc.
15 ("Autodesk").
16 
17 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
18 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
19 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR
20 ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES
21 OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
22 PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT
23 WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR
24 FREE.
25 
26 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
27 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR
28 EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE
29 DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS
30 OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR
31 DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF
32 LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT
33 LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE
34 DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS
35 BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
36 
37 **************************************************************************/
38 
45 #include <kaydaradef.h>
46 #ifndef FBSDK_DLL
47 
50 #define FBSDK_DLL K_DLLIMPORT
51 #endif
52 
53 #include <fbsdk/fbcomponent.h>
54 
55 #ifdef FBSDKUseNamespace
56 namespace FBSDKNamespace {
57 #endif //FBSDKUseNamespace
58 
60 
63 
68 {
70 
71 protected:
76 
77 public:
82  bool SetShowAudio( bool pShow );
83 
87  bool GetShowAudio();
88 
93  bool SetAudioClip( FBAudioClip* pAudioClip );
94 
99 
104  bool SetAudioTrack( FBStoryTrack* pAudioTrack );
105 
110 
114  bool RemoveAudio();
115 
120  bool SetShowLeftChannel( bool pShow );
121 
126 
131  bool SetShowRightChannel( bool pShow );
132 
137 
142  bool SetLockPitchToSpeed( bool pLock );
143 
148 
153 };
154 
155 #ifdef FBSDKUseNamespace
156 }
157 #endif //FBSDKUseNamespace
158 
159 #endif //__FBCAMERASWITCHERAUDIOMANAGER_H__
FBClassDeclare
#define FBClassDeclare(Name, Parent)
Class declaration.
Definition: fbdefines.h:85
FBSDK_DLL
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
Definition: fbcameraswitcheraudiomanager.h:50
FBCameraSwitcherAudioManager::GetShowAudio
bool GetShowAudio()
Get the 'Show Audio' state.
FBCameraSwitcherAudioManager::SetShowLeftChannel
bool SetShowLeftChannel(bool pShow)
Set the 'Show Left Channel' state.
FBCameraSwitcherAudioManager::SetAudioTrack
bool SetAudioTrack(FBStoryTrack *pAudioTrack)
Set the Audio Track to display on the Camera Switcher.
FBStoryTrack
Story Track class.
Definition: fbstory.h:643
FBCameraSwitcherAudioManager::FBCameraSwitcherAudioManager
FBCameraSwitcherAudioManager()
Constructor.
FBCameraSwitcherAudioManager::RemoveAudio
bool RemoveAudio()
Remove the audio clip or audio track currently displayed on the Camera Switcher.
FBCameraSwitcherAudioManager::TheOne
static FBCameraSwitcherAudioManager & TheOne()
Returns the only instance of FBCameraSwitcherAudioManager.
FBAudioClip
Used to play audio clips and access their properties.
Definition: fbaudio.h:305
FBCameraSwitcherAudioManager::GetLockPitchToSpeed
bool GetLockPitchToSpeed()
Get the 'Lock Pitch to Speed' state.
FBCameraSwitcherAudioManager::SetLockPitchToSpeed
bool SetLockPitchToSpeed(bool pLock)
Set the 'Lock Pitch to Speed' state.
FBCameraSwitcherAudioManager::SetAudioClip
bool SetAudioClip(FBAudioClip *pAudioClip)
Set the Audio Clip to display on the Camera Switcher.
FBCameraSwitcherAudioManager::SetShowRightChannel
bool SetShowRightChannel(bool pShow)
Set the 'Show Right Channel' state.
fbcomponent.h
Basic class definitions.
FBCameraSwitcherAudioManager
Camera Switcher Audio Manager class.
Definition: fbcameraswitcheraudiomanager.h:68
FBCameraSwitcherAudioManager::SetShowAudio
bool SetShowAudio(bool pShow)
Set the 'Show Audio' state.
FBCameraSwitcherAudioManager::GetAudioClip
FBAudioClip * GetAudioClip()
Get the Audio Clip displayed on the Camera Switcher.
FB_FORWARD
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:62
FB_DEFINE_COMPONENT
FB_DEFINE_COMPONENT(K_DLLIMPORT, AnimationNode)
Animation node class.
FBCameraSwitcherAudioManager::GetAudioTrack
FBStoryTrack * GetAudioTrack()
Get the Audio Track displayed on the Camera Switcher.
FBCameraSwitcherAudioManager::GetShowLeftChannel
bool GetShowLeftChannel()
Get the 'Show Left Channel' state.
FBCameraSwitcherAudioManager::GetShowRightChannel
bool GetShowRightChannel()
Get the 'Show Right Channel' state.
FBComponent
MotionBuilder SDK base class.
Definition: fbcomponent.h:651