Recording

Methods

getDefaultRecordingSaveDirectory() → {string}
Returns:
Type: string
getPlayerUseAttachments() → {boolean}
Returns:
Type: boolean
getPlayerUseDisplayName() → {boolean}
Returns:
Type: boolean
getPlayerUseHeadModel() → {boolean}
Returns:
Type: boolean
getPlayerUseSkeletonModel() → {boolean}
Returns:
Type: boolean
getPlayFromCurrentLocation() → {boolean}
Returns:
Type: boolean
isPaused() → {boolean}
Returns:
Type: boolean
isPlaying() → {boolean}
Returns:
Type: boolean
isRecording() → {boolean}
Returns:
Type: boolean
loadLastRecording()
loadRecording(url, callbackopt)
Parameters:
Name Type Attributes Default Description
url string
callback Recording~loadRecordingCallback <optional>
null
pausePlayer()
playerElapsed() → {number}
Returns:
Type: number
playerLength() → {number}
Returns:
Type: number
recorderElapsed() → {number}
Returns:
Type: number
saveRecording(filename)
Parameters:
Name Type Description
filename string
saveRecordingToAsset(getClipAtpUrl)
Parameters:
Name Type Description
getClipAtpUrl function
setPlayerAudioOffset(audioOffset)
Parameters:
Name Type Description
audioOffset number
setPlayerLoop(loop)
Parameters:
Name Type Description
loop boolean
setPlayerTime(time)
Parameters:
Name Type Description
time number
setPlayerUseAttachments(useAttachments)
Parameters:
Name Type Description
useAttachments boolean
setPlayerUseDisplayName(useDisplayName)
Parameters:
Name Type Description
useDisplayName boolean
setPlayerUseHeadModel(useHeadModel)
Parameters:
Name Type Description
useHeadModel boolean
To Do:
  • Note: This function currently has no effect.
setPlayerUseSkeletonModel(useSkeletonModel)
Parameters:
Name Type Description
useSkeletonModel boolean
To Do:
  • Note: This function currently doesn't work.
setPlayerVolume(volume)
Parameters:
Name Type Description
volume number
setPlayFromCurrentLocation(playFromCurrentLocation)
Parameters:
Name Type Description
playFromCurrentLocation boolean
startPlaying()
startRecording()
stopPlaying()
stopRecording()

Type Definitions

loadRecordingCallback(success, url)
Called when Recording.loadRecording is complete.
Parameters:
Name Type Description
success boolean
url string