Interface IScreenRecorder
Interface for holding an instance of VideoRecorder or GidRecorder used for recording.
Namespace: VoxelBusters.ScreenRecorderKit
Assembly: cs.temp.dll.dll
Syntax
public interface IScreenRecorder
Methods
CanRecord()
Check if recording is allowed or not.
Declaration
bool CanRecord()
Returns
Type | Description |
---|---|
System.Boolean | Returns false if recording api is not available or if resources are not available for recording. |
DiscardRecording(CompletionCallback)
Discard an active recording. This won't trigger SetOnRecordingAvailable callback as the current recording is disposed.
Declaration
void DiscardRecording(CompletionCallback callback = null)
Parameters
Type | Name | Description |
---|---|---|
CompletionCallback | callback | Callback to get triggered once discard action is complete. |
Flush()
Flush any resources created for recording.
Declaration
void Flush()
IsPausedOrRecording()
Check if an active recording exists
Declaration
bool IsPausedOrRecording()
Returns
Type | Description |
---|---|
System.Boolean | Returns true if a recording is active or recording is paused. False if no active recording exists. |
IsRecording()
Check if recording is happening or not.
Declaration
bool IsRecording()
Returns
Type | Description |
---|---|
System.Boolean | Returns true if recording is active and not paused. False if no active recording exists or a recording is paused |
OpenRecording(CompletionCallback)
Open an active recording which just got recorded.
Declaration
void OpenRecording(CompletionCallback callback = null)
Parameters
Type | Name | Description |
---|---|---|
CompletionCallback | callback | Callback to get triggered once the action is complete. |
PauseRecording(CompletionCallback)
Pause an active recording
Declaration
void PauseRecording(CompletionCallback callback = null)
Parameters
Type | Name | Description |
---|---|---|
CompletionCallback | callback | Callback to get triggered once after pause action is complete. |
PrepareRecording(CompletionCallback)
Prepare for recording
Declaration
void PrepareRecording(CompletionCallback callback = null)
Parameters
Type | Name | Description |
---|---|---|
CompletionCallback | callback | Callback to get triggered once prepare action is complete |
SaveRecording(CompletionCallback<ScreenRecorderSaveRecordingResult>)
Save an active recording
Declaration
void SaveRecording(CompletionCallback<ScreenRecorderSaveRecordingResult> callback = null)
Parameters
Type | Name | Description |
---|---|---|
CompletionCallback<VoxelBusters.ScreenRecorderKit.ScreenRecorderSaveRecordingResult> | callback | Callback to get triggered once save action is complete. This returns a result where you can fetch path. |
SaveRecording(String, CompletionCallback<ScreenRecorderSaveRecordingResult>)
Save an active recording with a provided filename.
Declaration
void SaveRecording(string fileName, CompletionCallback<ScreenRecorderSaveRecordingResult> callback = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | fileName | Filename to be set on saving a recording. |
CompletionCallback<VoxelBusters.ScreenRecorderKit.ScreenRecorderSaveRecordingResult> | callback | Callback to get triggered once save action is complete. This returns a result where you can fetch path. |
SetOnRecordingAvailable(SuccessCallback<ScreenRecorderRecordingAvailableResult>)
Set a callback to get triggered when a recording result is available. This will be GifTexture in-case of gif recording or video file path in-case of video recording.
Declaration
void SetOnRecordingAvailable(SuccessCallback<ScreenRecorderRecordingAvailableResult> callback = null)
Parameters
Type | Name | Description |
---|---|---|
SuccessCallback<VoxelBusters.ScreenRecorderKit.ScreenRecorderRecordingAvailableResult> | callback | Callback to get triggered once a recording is available. |
ShareRecording(String, String, CompletionCallback)
Share an active recording which just got recorded.
Declaration
void ShareRecording(string text = null, string subject = null, CompletionCallback callback = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | text | Share text used for sharing. |
System.String | subject | Subject text that needs to be used as subject. |
CompletionCallback | callback | Callback that gets triggered once share action is complete. |
StartRecording(CompletionCallback)
Start a recording
Declaration
void StartRecording(CompletionCallback callback = null)
Parameters
Type | Name | Description |
---|---|---|
CompletionCallback | callback | Callback to get triggered once start action is complete |
StopRecording(CompletionCallback)
Stop an active recording
Declaration
void StopRecording(CompletionCallback callback = null)
Parameters
Type | Name | Description |
---|---|---|
CompletionCallback | callback | Callback to get triggered once after stop action is complete. |
StopRecording(Boolean, CompletionCallback)
Stop an active recording
Declaration
void StopRecording(bool flushMemory, CompletionCallback callback = null)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | flushMemory | If true, clears all the memory allocated for this recording. |
CompletionCallback | callback | Callback to get triggered once after stop action is complete. |