One Logo Pool Ball
ReplayKit · IOS API REFERENCE

RPScreenRecorder

class · iOS 9.0+ · Deprecated in iOS 27.0 · SDK 27.1

class RPScreenRecorder

Members (22)

static · iOS 9.0+ · Deprecated in iOS 27.0

shared

TypeScript
static shared(): RPScreenRecorder
Swift declaration
class func shared() -> RPScreenRecorder
method · iOS 9.0+ · Deprecated in iOS 27.0

discardRecording

TypeScript
discardRecording(handler: (() => void)): void
Swift declaration
func discardRecording(handler: @escaping () -> Void)
method · iOS 15.0+ · Deprecated in iOS 27.0

exportClip

TypeScript
exportClip(url: string, duration: number, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func exportClip(to url: URL, duration: TimeInterval) async throws
method · iOS 11.0+ · Deprecated in iOS 27.0

startCapture

TypeScript
startCapture(captureHandler?: (((arg0: _CoreMedia_CMSampleBuffer, arg1: RPSampleBufferType, arg2: (NativeError) | null) => void)) | null, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func startCapture(handler captureHandler: ((CMSampleBuffer, RPSampleBufferType, (any Error)?) -> Void)?) async throws
method · iOS 15.0+ · Deprecated in iOS 27.0

startClipBuffering

TypeScript
startClipBuffering(completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func startClipBuffering() async throws
method · iOS 10.0+ · Deprecated in iOS 27.0

startRecording

TypeScript
startRecordingHandler(handler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func startRecording(handler: (((any Error)?) -> Void)? = nil)
method · iOS 9.0+ · Deprecated in iOS 10.0

startRecording

TypeScript
startRecordingWithMicrophoneEnabledHandler(microphoneEnabled: boolean, handler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func startRecording(withMicrophoneEnabled microphoneEnabled: Bool, handler: (((any Error)?) -> Void)? = nil)
method · iOS 11.0+ · Deprecated in iOS 27.0

stopCapture

TypeScript
stopCapture(handler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func stopCapture(handler: (((any Error)?) -> Void)? = nil)
method · iOS 15.0+ · Deprecated in iOS 27.0

stopClipBuffering

TypeScript
stopClipBuffering(completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func stopClipBuffering() async throws
method · iOS 9.0+ · Deprecated in iOS 27.0

stopRecording

TypeScript
stopRecordingHandler(handler?: (((arg0: (RPPreviewViewController) | null, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func stopRecording(handler: ((RPPreviewViewController?, (any Error)?) -> Void)? = nil)
method · iOS 14.0+ · Deprecated in iOS 27.0

stopRecording

TypeScript
stopRecordingWithOutputCompletionHandler(url: string, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func stopRecording(withOutput url: URL) async throws
get · iOS 9.0+ · Deprecated in iOS 27.0

isAvailable

TypeScript
get isAvailable(): boolean
Swift declaration
var isAvailable: Bool { get }
get · iOS 10.0+ · Deprecated in iOS 27.0

isCameraEnabled

TypeScript
get isCameraEnabled(): boolean
Swift declaration
var isCameraEnabled: Bool { get set }
set · iOS 10.0+ · Deprecated in iOS 27.0

isCameraEnabled

TypeScript
set isCameraEnabled(value: boolean)
Swift declaration
var isCameraEnabled: Bool { get set }
get · iOS 11.0+ · Deprecated in iOS 27.0

cameraPosition

TypeScript
get cameraPosition(): RPCameraPosition
Swift declaration
var cameraPosition: RPCameraPosition { get set }
set · iOS 11.0+ · Deprecated in iOS 27.0

cameraPosition

TypeScript
set cameraPosition(value: RPCameraPosition)
Swift declaration
var cameraPosition: RPCameraPosition { get set }
get · iOS 10.0+ · Deprecated in iOS 27.0

cameraPreviewView

TypeScript
get cameraPreviewView(): (_UIKit_UIView) | null
Swift declaration
var cameraPreviewView: UIView? { get }
get · iOS 9.0+ · Deprecated in iOS 27.0

delegate

TypeScript
get delegate(): (SDKHandle) | null
Swift declaration
weak var delegate: (any RPScreenRecorderDelegate)? { get set }
set · iOS 9.0+ · Deprecated in iOS 27.0

delegate

TypeScript
set delegate(value: (Implements<RPScreenRecorderDelegate> | SDKHandle) | null)
Swift declaration
weak var delegate: (any RPScreenRecorderDelegate)? { get set }
get · iOS 9.0+ · Deprecated in iOS 27.0

isMicrophoneEnabled

TypeScript
get isMicrophoneEnabled(): boolean
Swift declaration
var isMicrophoneEnabled: Bool { get set }
set · iOS 9.0+ · Deprecated in iOS 27.0

isMicrophoneEnabled

TypeScript
set isMicrophoneEnabled(value: boolean)
Swift declaration
var isMicrophoneEnabled: Bool { get set }
get · iOS 9.0+ · Deprecated in iOS 27.0

isRecording

TypeScript
get isRecording(): boolean
Swift declaration
var isRecording: Bool { get }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

RPScreenRecorder.init()

inherited init: clang: 'init' is unavailable: not available on iOS

All ReplayKit types →