Class ISN_RPScreenRecorder
The shared recorder object providing the ability to record audio and video of your app.
Inheritance
Inherited Members
Namespace: SA.iOS.ReplayKit
Assembly: cs.temp.dll.dll
Syntax
public static class ISN_RPScreenRecorder
Properties
DidChangeAvailability
Indicates that the recorder has changed states between disabled and enabled.
Screen recording can be unavailable due to unsupported hardware, the user’s device displaying information over Airplay or through a TVOut session, or another app using the shared recorder.
Declaration
public static SA_iEvent DidChangeAvailability { get; }
Property Value
Type | Description |
---|---|
SA_iEvent |
DidStopRecording
Gets the did stop recording.
This method is called when recording stops due to an error or a change in recording availability. If any part of the stopped recording is available, an instance of ISN_RPStopResult is returned.
Declaration
public static SA_iEvent<ISN_RPStopResult> DidStopRecording { get; }
Property Value
Type | Description |
---|---|
SA_iEvent<ISN_RPStopResult> |
IsAvailable
A Boolean value that indicates whether the screen recorder is available for recording.
Declaration
public static bool IsAvailable { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsMicrophoneEnabled
A Boolean value that indicates whether the microphone is currently enabled.
Declaration
public static bool IsMicrophoneEnabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsRecording
A Boolean value that indicates whether the app is currently recording.
Declaration
public static bool IsRecording { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
DiscardRecording(Action)
Discards the current recording.
Method can only be called after the StopRecording(Action<ISN_RPStopResult>) callback has been called. Use the handler block to do any required cleanup, including setting any ISN_RPPreviewViewController references to null.
Declaration
public static void DiscardRecording(Action callback)
Parameters
Type | Name | Description |
---|---|---|
Action | callback | Callback. |
StartRecording(Action<SA_Result>)
Starts recording the app display.
When StartRecording(Action<SA_Result>) is first called, an alert window appears asking the user to confirm recording. This alert window is also presented if it has been longer than 8 minutes since the last time StartRecording(Action<SA_Result>) was called.
Declaration
public static void StartRecording(Action<SA_Result> callback)
Parameters
Type | Name | Description |
---|---|---|
Action<SA_Result> | callback | A callback that is called when the request completes. |
StopRecording(Action<ISN_RPStopResult>)
Stops the current recording.
When recording stops and there is no error associated with the recording, present the the resulting preview view controller using ISN_RPPreviewViewController. The user will see the built-in preview view controller, providing them with the option to trim, cut, and share the recording. On the iPad, the preview view controller will be presented as popover.
Declaration
public static void StopRecording(Action<ISN_RPStopResult> callback)
Parameters
Type | Name | Description |
---|---|---|
Action<ISN_RPStopResult> | callback | A callback that is called when the request completes. |