Python Reference Guide
 
Loading...
Searching...
No Matches
FBCameraSwitcherAudioManager Class Reference

Camera Switcher Audio Manager class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBCameraSwitcherAudioManager:

Public Member Functions

FBAudioClip GetAudioClip ()
 Get the Audio Clip displayed on the Camera Switcher.
 
FBStoryTrack GetAudioTrack ()
 Get the Audio Track displayed on the Camera Switcher.
 
bool GetLockPitchToSpeed ()
 Get the 'Lock Pitch to Speed' state.
 
bool GetShowAudio ()
 Get the 'Show Audio' state.
 
bool GetShowLeftChannel ()
 Get the 'Show Left Channel' state.
 
bool GetShowRightChannel ()
 Get the 'Show Right Channel' state.
 
bool RemoveAudio ()
 Remove the audio clip or audio track currently displayed on the Camera Switcher.
 
bool SetAudioClip (FBAudioClip pAudioClip)
 Set the Audio Clip to display on the Camera Switcher.
 
bool SetAudioTrack (FBStoryTrack pAudioTrack)
 Set the Audio Track to display on the Camera Switcher.
 
bool SetLockPitchToSpeed (bool pLock)
 Set the 'Lock Pitch to Speed' state.
 
bool SetShowAudio (bool pShow)
 Set the 'Show Audio' state.
 
bool SetShowLeftChannel (bool pShow)
 Set the 'Show Left Channel' state.
 
bool SetShowRightChannel (bool pShow)
 Set the 'Show Right Channel' state.
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor.
 
str ClassName ()
 Get the class name.
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags.
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags.
 
bool FBCreate ()
 Open Reality Creation function.
 
 FBDelete ()
 Open Reality deletion function.
 
 FBDestroy ()
 Open Reality destruction function.
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated).
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled.
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object.
 
 HardSelect ()
 HardSelect.
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled.
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId.
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy.
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace.
 
int PropertyAdd (FBProperty pProperty)
 Add a property to the component's property manager.
 
bool PropertyAddReferenceProperty (FBProperty pReferenceProperty)
 Add a reference property to the component's property manager.
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property.
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading.
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager.
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags.
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status.
 

Additional Inherited Members

- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.

 
str LongName
 Read Write Property: Name and namespace for object.

 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
 
FBListComponent Parents
 List: Parents.

 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.

 
bool Selected
 Read Write Property: Selected property.

 
int TypeInfo
 Contains the Type information of the object.

 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.

 
int TypeInfo
 TypeInfo.

 

Detailed Description

Camera Switcher Audio Manager class.


This class allows users to interact with the Audio Manager of the Camera Switcher.

Member Function Documentation

◆ GetAudioClip()

FBAudioClip GetAudioClip ( )

Get the Audio Clip displayed on the Camera Switcher.

Returns
The Audio Clip displayed, nullptr (C++) / None (Python) if any.

◆ GetAudioTrack()

FBStoryTrack GetAudioTrack ( )

Get the Audio Track displayed on the Camera Switcher.

Returns
The Audio Track displayed, nullptr (C++) / None (Python) if any.

◆ GetLockPitchToSpeed()

bool GetLockPitchToSpeed ( )

Get the 'Lock Pitch to Speed' state.

Returns
True if the 'Lock Pitch to Speed' state is set, false otherwise.

◆ GetShowAudio()

bool GetShowAudio ( )

Get the 'Show Audio' state.

Returns
True if the 'Show Audio' state is set, false otherwise.

◆ GetShowLeftChannel()

bool GetShowLeftChannel ( )

Get the 'Show Left Channel' state.

Returns
True if the 'Show Left Channel' state is set, false otherwise.

◆ GetShowRightChannel()

bool GetShowRightChannel ( )

Get the 'Show Right Channel' state.

Returns
True if the 'Show Right Channel' state is set, false otherwise.

◆ RemoveAudio()

bool RemoveAudio ( )

Remove the audio clip or audio track currently displayed on the Camera Switcher.

Returns
True if the operation is successful, false otherwise.

◆ SetAudioClip()

bool SetAudioClip ( FBAudioClip  pAudioClip)

Set the Audio Clip to display on the Camera Switcher.

Parameters
pAudioClipThe Audio Clip to display.
Returns
True if the operation is successful, false otherwise.

◆ SetAudioTrack()

bool SetAudioTrack ( FBStoryTrack  pAudioTrack)

Set the Audio Track to display on the Camera Switcher.

Parameters
pAudioTrackThe Audio Track to display.
Returns
True if the operation is successful, false otherwise.

◆ SetLockPitchToSpeed()

bool SetLockPitchToSpeed ( bool  pLock)

Set the 'Lock Pitch to Speed' state.

Parameters
pLockTrue to lock pitch to speed, false otherwise.
Returns
True if the operation is successful, false otherwise.

◆ SetShowAudio()

bool SetShowAudio ( bool  pShow)

Set the 'Show Audio' state.

Parameters
pShowTrue to show the Audio waveform, false otherwise.
Returns
True if the operation is successful, false otherwise.

◆ SetShowLeftChannel()

bool SetShowLeftChannel ( bool  pShow)

Set the 'Show Left Channel' state.

Parameters
pShowTrue to show the left channel, false otherwise.
Returns
True if the operation is successful, false otherwise.

◆ SetShowRightChannel()

bool SetShowRightChannel ( bool  pShow)

Set the 'Show Right Channel' state.

Parameters
pShowTrue to show the right channel, false otherwise.
Returns
True if the operation is successful, false otherwise.