Class RecoludeConfig

Stores credentials that can be used to access Recolude's different services. This config can be instantiated at runtime, but an easier way of keeping up with credentials to your application might be to instantiate it right in the Assets folder in your project. You can right-click anywhere in your project’s Asset folder and select “Create > Recolude > Config”.

Inheritance

System.Object

UnityEngine.Object

UnityEngine.ScriptableObject

RecoludeConfig

Implements

UnityEngine.ISerializationCallbackReceiver

IRecordingStorage

Config

Inherited Members

UnityEngine.ScriptableObject.SetDirty()

UnityEngine.ScriptableObject.CreateInstance(System.String)

UnityEngine.ScriptableObject.CreateInstance(System.Type)

UnityEngine.ScriptableObject.CreateInstance<T>()

UnityEngine.Object.GetInstanceID()

UnityEngine.Object.GetHashCode()

UnityEngine.Object.Equals(System.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Instantiate<T>(T)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)

UnityEngine.Object.Destroy(UnityEngine.Object)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object)

UnityEngine.Object.FindObjectsOfType(System.Type)

UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)

UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)

UnityEngine.Object.DestroyObject(UnityEngine.Object)

UnityEngine.Object.FindSceneObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)

UnityEngine.Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.ToString()

UnityEngine.Object.name

UnityEngine.Object.hideFlags

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Recolude.API

Assembly: Recolude.API.dll

Syntax

[Serializable]
[CreateAssetMenu(menuName = "Recolude/Config", fileName = "RecoludeConfig")]
public class RecoludeConfig : ScriptableObject, ISerializationCallbackReceiver, IRecordingStorage, Config

Properties

ApiKeyAuth

API Key generated on recolude.com that has had specific permissions attached to it.

Declaration

public string ApiKeyAuth { get; }

Property Value

Type	Description
System.String

BasePath

The URL we will be targeting for making our calls to Recolude

Declaration

public string BasePath { get; }

Property Value

Type	Description
System.String

CognitoAuth

Cognito auth token if the user chooses to sign into their account inside a unity application

Declaration

public string CognitoAuth { get; }

Property Value

Type	Description
System.String

DevKeyAuth

Personal Development key for managing cloud Recolude configurations inside a unity application.

Declaration

public string DevKeyAuth { get; }

Property Value

Type	Description
System.String

Methods

BuildDownloadRecordingRequest(String)

Builds a HTTP network request to download a recording, but does not execute it. The developer can choose whenever to call it. You most likely want to be using SaveRecording

Declaration

public UnityWebRequest BuildDownloadRecordingRequest(string recordingID)

Parameters

Type	Name	Description
System.String	recordingID	ID of the recording to download.

Returns

Type	Description
UnityEngine.Networking.UnityWebRequest	The network request that still needs to be ran

BuildUploadRecordingRequest(IRecording, RecordingVisibility)

Builds a HTTP network request to upload a recording, but does not execute it. The developer can choose whenever to call it. You most likely want to be using SaveRecording

Declaration

public UnityWebRequest BuildUploadRecordingRequest(IRecording thingToUpload, RecordingVisibility visibility)

Parameters

Type	Name	Description
IRecording	thingToUpload	Recording to upload
RecordingVisibility	visibility

Returns

Type	Description
UnityEngine.Networking.UnityWebRequest	The network request that still needs to be ran

CreateInstance(String, String)

Constructs an instance of the Recolude config scriptable object.

Declaration

public static RecoludeConfig CreateInstance(string apiKey, string projectID)

Parameters

Type	Name	Description
System.String	apiKey	API key that will be used when making calls to Recolude
System.String	projectID	ID of the project we want to interface with inside of Recolude.

Returns

Type	Description
RecoludeConfig

DefaultUploadVisibility()

The default visibility for the recordings that get uploaded when no visibility is specified in a direct upload call.

Declaration

public RecordingVisibility DefaultUploadVisibility()

Returns

Type	Description
RecordingVisibility	The default visibility for recordings

DeleteRecording(String)

Creates an operation that when ran, will delete a recording from Recolude.

Declaration

public IDeleteRecordingOperation DeleteRecording(string id)

Parameters

Type	Name	Description
System.String	id

Returns

Type	Description
IDeleteRecordingOperation	Request that when ran, will delete the recording.

GetAPIKey()

API Key used to identify the application with Recolude.

Declaration

public string GetAPIKey()

Returns

Type	Description
System.String	API Key used to identify the application with Recolude.

GetProjectID()

ID of the project we want to interface with.

Declaration

public string GetProjectID()

Returns

Type	Description
System.String	ID of the project we want to interface with.

GetURL()

URL to Recolude

Declaration

public string GetURL()

Returns

Type	Description
System.String	URL to Recolude

LoadRecording(String)

Creates an operation that when ran, loads a recording from Recolude.

Declaration

public ILoadRecordingOperation LoadRecording(string recordingID)

Parameters

Type	Name	Description
System.String	recordingID	ID of the recording to download.

Returns

Type	Description
ILoadRecordingOperation	Request that when ran, will download the recording.

OnAfterDeserialize()

DO NOT CALL: For Unity Scriptable Object Serialization Purposes.

Declaration

public void OnAfterDeserialize()

OnBeforeSerialize()

DO NOT CALL: For Unity Scriptable Object Serialization Purposes.

Declaration

public void OnBeforeSerialize()

SaveRecording(IRecording)

Creates an operation that when ran, will upload the recording under these specific.

Declaration

public ISaveRecordingOperation SaveRecording(IRecording thingToUpload)

Parameters

Type	Name	Description
IRecording	thingToUpload	Recording to upload

Returns

Type	Description
ISaveRecordingOperation	Request that when ran, will save the recording to Recolude.

SetAPIKey(String)

Configures the client to point to the ID of the project inside of Recolude.

Declaration

public bool SetAPIKey(string newKey)

Parameters

Type	Name	Description
System.String	newKey	The new api key to use.

Returns

Type	Description
System.Boolean	Whether or not an update actually occurred (no update occurs if the new ID matches the present one).

SetDefaultUploadVisibility(RecordingVisibility)

Assign the visibility to use for uploading recordings, when no other is specified.

Declaration

public bool SetDefaultUploadVisibility(RecordingVisibility visibility)

Parameters

Type	Name	Description
RecordingVisibility	visibility	The recording visibility to use

Returns

Type	Description
System.Boolean

SetProjectID(String)

Configures the client to interface with a specific project inside of Recolude.

Declaration

public bool SetProjectID(string projectID)

Parameters

Type	Name	Description
System.String	projectID	The ID of the project to interface with.

Returns

Type	Description
System.Boolean	Whether or not an update actually occurred (no update occurs if the new ID matches the present one).

UploadRecording(IRecording)

Declaration

public void UploadRecording(IRecording thingToUpload)

Parameters

Type	Name	Description
IRecording	thingToUpload

Implements

UnityEngine.ISerializationCallbackReceiver

IRecordingStorage

Config