AvatarRecordingService Class

Handles Avatar recording

Inheritance Hierarchy

SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDKLoggingBehaviour
            ImmerseSDKSingletonBehaviour
              ImmerseSDK.AvatarsAvatarRecordingService

Namespace: ImmerseSDK.Avatars
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)

Syntax

[ScriptOrderAttribute(-29000)]
public class AvatarRecordingService : SingletonBehaviour

The AvatarRecordingService type exposes the following members.

Constructors

	Name	Description
	AvatarRecordingService	Initializes a new instance of the AvatarRecordingService class

Properties

	Name	Description
	IsPlaying	Are we currently playing back a recording?
	IsRecording	Are we currently recording?
	IsStartRecordingEnabled	Enable/Disable recording

Methods

	Name	Description
	CoroutineInitialise	Initialisation routine, called by the SDK (Overrides SingletonBehaviourCoroutineInitialise.)
	HasMoreKeyframes	True if the current recording has more key frames
	LoadRecordingDataFromFile(String)	Loads recording data from file
	LoadRecordingDataFromFile(String, Boolean)	Loads recording data from file
	LoadRecordingDataFromResource(String)	Loads recording data from resource
	LoadRecordingDataFromResource(String, Boolean)	Loads recording data from resource
	SaveRecording	Saves a recording to disk using a timestamped filename
	SendRecordingToUser(UserID, ConsumerRecordingData)	Send to recording to a user and play it
	SendRecordingToUser(UserID, Byte)	Send to recording to a user and play it
	SendRecordingToUser(UserID, String)	Send to recording to a user and play it
	StartPlayback	Start playback of an avatar recording
	StartPlaybackFromFile	Start playback of an avatar recording
	StartPlaybackFromResource	Start playback of an avatar recording
	StartRecording(String)	Start recording the local user's avatar
	StartRecording(IAvatarDataProvider, String)	Start recording using the data provider specified
	StartStopRecording	Method to get the recording to start or stop depending on the passed in parameters and the current state of recording
	StopPlayback	Stop playback of an avatar recording
	StopRecording	Stop the current recording and save the file to disk

Fields

	Name	Description
	FileExtension	File extension of an avatar recording file
	RecorderVersion	Current version of the Avatar recording system
	RelativePathToRecordingDataInBuild	Path where we expect avatar recordings to be located (relative to a build)
	RelativePathToRecordingDataInEditor	Path where we expect avatar recordings to be located (relative to the Unity project assets folder)

Extension Methods

	Name	Description
	GetCopyOf	Copies all properties of a component from source to target. Uses reflection to set properties. (Defined by ComponentExtensions.)
	WaitForT	Waits for a singleton on a coroutine (Defined by SingletonManager.)