Recording

Description

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts • Assignment Client Scripts

Methods

Name Return Value Summary
getDefaultRecordingSaveDirectory string
getPlayerUseAttachments boolean
getPlayerUseDisplayName boolean
getPlayerUseHeadModel boolean
getPlayerUseSkeletonModel boolean
getPlayFromCurrentLocation boolean
isPaused boolean
isPlaying boolean
isRecording boolean
loadLastRecording None
loadRecording None
pausePlayer None
playerElapsed number
playerLength number
recorderElapsed number
saveRecording None
saveRecordingToAsset None
setPlayerAudioOffset None
setPlayerLoop None
setPlayerTime None
setPlayerUseAttachments None
setPlayerUseDisplayName None
setPlayerUseHeadModel None

To Do:

  • Note: This function currently has no effect.

setPlayerUseSkeletonModel None

To Do:

  • Note: This function currently doesn't work.

setPlayerVolume None
setPlayFromCurrentLocation None
startPlaying None
startRecording None
stopPlaying None
stopRecording None

Type Definitions

loadRecordingCallback( success, url )
Type: function

Called when Recording.loadRecording is complete.

Method Details

(static) getDefaultRecordingSaveDirectory( ) → {string}
Returns: string

(static) getPlayerUseAttachments( ) → {boolean}
Returns: boolean

(static) getPlayerUseDisplayName( ) → {boolean}
Returns: boolean

(static) getPlayerUseHeadModel( ) → {boolean}
Returns: boolean

(static) getPlayerUseSkeletonModel( ) → {boolean}
Returns: boolean

(static) getPlayFromCurrentLocation( ) → {boolean}
Returns: boolean

(static) isPaused( ) → {boolean}
Returns: boolean

(static) isPlaying( ) → {boolean}
Returns: boolean

(static) isRecording( ) → {boolean}
Returns: boolean

(static) loadLastRecording( )

(static) loadRecording( url, callbackopt )

Parameters

Name Type Attributes Default Value Description
url string
callback Recording~loadRecordingCallback <optional>
null
(static) pausePlayer( )

(static) playerElapsed( ) → {number}
Returns: number

(static) playerLength( ) → {number}
Returns: number

(static) recorderElapsed( ) → {number}
Returns: number

(static) saveRecording( filename )

Parameters

Name Type Description
filename string
(static) saveRecordingToAsset( getClipAtpUrl )

Parameters

Name Type Description
getClipAtpUrl function
(static) setPlayerAudioOffset( audioOffset )

Parameters

Name Type Description
audioOffset number
(static) setPlayerLoop( loop )

Parameters

Name Type Description
loop boolean
(static) setPlayerTime( time )

Parameters

Name Type Description
time number
(static) setPlayerUseAttachments( useAttachments )

Parameters

Name Type Description
useAttachments boolean
(static) setPlayerUseDisplayName( useDisplayName )

Parameters

Name Type Description
useDisplayName boolean
(static) setPlayerUseHeadModel( useHeadModel )

To Do:

  • Note: This function currently has no effect.

Parameters

Name Type Description
useHeadModel boolean
(static) setPlayerUseSkeletonModel( useSkeletonModel )

To Do:

  • Note: This function currently doesn't work.

Parameters

Name Type Description
useSkeletonModel boolean
(static) setPlayerVolume( volume )

Parameters

Name Type Description
volume number
(static) setPlayFromCurrentLocation( playFromCurrentLocation )

Parameters

Name Type Description
playFromCurrentLocation boolean
(static) startPlaying( )

(static) startRecording( )

(static) stopPlaying( )

(static) stopRecording( )