Screen recording

Development environment

You need Xcode 14.0 or later, and the phone must run iOS 16.0 or later (the SDK’s minimum system requirement starting with 2.1.0; versions before 2.1.0 need iOS 12 or later to use screen recording).

Create the extension

In your existing project, choose [New] -> [Target…] and select [Broadcast Upload Extension], as shown:

Set the Product Name. After you click [Finish], the project has a new directory named after the Product Name you entered, containing a system-generated SampleHandler class that handles screen recording, plus a corresponding Product Name SetupUI directory containing a system-generated BroadcastSetupViewController class that handles the screen recording UI.

Add the SDK dependency to the extension

To integrate MeetingKit.framework into the screen recording extension, update the Podfile and run pod install, as shown:

Add background permissions to the host app

In the host project, go to [TARGETS] -> [Signing & Capabilities] -> [Capability] and select [Background Modes], as shown:

Double-click to add it, then check [Audio, AirPlay, and Picture in Picture], as shown:

Integration steps

1. Where you need the recording service, import #import <MeetingKit/MeetingKit.h> and create an RPSystemBroadcastPickerView object, as shown:

2. To customize the button, replace the RPSystemBroadcastPickerView button as follows. If the page below appears after the broadcastButton event fires, the extension is integrated successfully:

3. In the host project, pass in MeetingKitRoomDelegate when creating the room instance, and implement the screen sharing status callback:

Starting with 2.0.0, the process-side screen capture integration (broadcastStartedWithAppGroup:delegate:, sendSampleBuffer:withType:) stays on the MeetingKit singleton, while the screen sharing status callback has moved to MeetingKitRoomDelegate along with the other in-meeting events, and carries the room instance the event came from. To stop sharing, call stopScreenRecord on the room instance.

/// Screen capture status callback
/// @param room Room instance the event came from
/// @param status Status code
- (void)meetingRoom:(MeetingKitRoom *)room onScreenRecordStatus:(SEAScreenRecordStatus)status {
    
    SGLOG(@"Screen sharing status notification, status = %ld", status);
    
    switch (status) {
        case SEAScreenRecordStatusError:
            /// Screen capture connection error
            break;
        case SEAScreenRecordStatusStop:
            /// Screen capture has stopped
            break;
        case SEAScreenRecordStatusStart:
            /// Screen capture has started
            break;
        default:
            break;
    }
}

4. Implement the RTCScreenDelegate delegate in the screen extension’s SampleHandler:

@interface SampleHandler : NSObject <MeetingKitScreenDelegate>
/// Add any of the following callbacks here as needed.

/// Screen recording finished callback
/// @param engine Callback instance
/// @param reason Reason for finishing
- (void)broadcastFinished:(MeetingKit *)engine reason:(NSString *)reason {

    /// Description
    NSString *describe = @"Screen recording has ended";
    /// Build the error
    NSError *error = [NSError errorWithDomain:NSStringFromClass(self.class) code:0 userInfo:@{NSLocalizedFailureReasonErrorKey : describe}];
    /// Finish screen recording
    [self finishBroadcastWithError:error];
}

5. Start screen recording in the screen extension’s SampleHandler:

- (void)broadcastStartedWithSetupInfo:(NSDictionary<NSString *,NSObject *> *)setupInfo {
    
    /// User has requested to start the broadcast. Setup info from the UI extension can be supplied but optional.
    [[MeetingKit sharedInstance] broadcastStartedWithAppGroup:@"Application Group Identifier" delegate:self];
}

6. Send shared screen frames in the screen extension’s SampleHandler:

- (void)processSampleBuffer:(CMSampleBufferRef)sampleBuffer withType:(RPSampleBufferType)sampleBufferType {
    
    /// Send media data (audio and video)
    [[MeetingKit sharedInstance] sendSampleBuffer:sampleBuffer withType:sampleBufferType];
}

Overview

Low-code integration

Web SDK

Android SDK

Windows SDK

Swift SDK (iOS/macOS)

iOS SDK (Objective-C)

Server API

Development environment

Create the extension

Add the SDK dependency to the extension

Add background permissions to the host app

Integration steps

​Development environment

​Create the extension

​Add the SDK dependency to the extension

​Add background permissions to the host app

​Integration steps

Development environment

Create the extension

Add the SDK dependency to the extension

Add background permissions to the host app

Integration steps