Screen Sharing

If users only share screen and audio within the app, they can call the startScreenCaptureInApp interface to enable screen sharing. You can also call the broadcastFinished interface callback to receive screen sharing end notifications. If screen capture fails, you can receive the reason for failure.

ZegoScreenCaptureConfig *config = [[ZegoScreenCaptureConfig alloc] init];
config.captureVideo = true;
config.captureAudio = true;
// Optional parameter, set the video capture area, must be within the original video data, unit is pixels (px)
config.cropRect = CGRectMake(x, y, width, height);
[ZegoExpressEngine.sharedEngine startScreenCaptureInApp:config];

ZegoScreenCaptureConfig *config = [[ZegoScreenCaptureConfig alloc] init];
config.captureVideo = true;
config.captureAudio = true;
// Optional parameter, set the video capture area, must be within the original video data, unit is pixels (px)
config.cropRect = CGRectMake(x, y, width, height);
[ZegoExpressEngine.sharedEngine startScreenCaptureInApp:config];

Cross-app screen sharing is recorded by the iOS system through the Extension process, so you need to additionally create and launch an extension process. For details, please refer to the following implementation steps:

1 Create Broadcast Upload Extension

1. Use Xcode to open the project file, and click "File > New > Target..." in the menu bar in sequence.

   

2. In the pop-up window, select "Broadcast Upload Extension" on the iOS page, then click "Next".

   

3. In the "Product Name" field of the pop-up dialog box, fill in the name of "Broadcast Upload Extension", for example "ScreenShare". After selecting "Team", "Language" and other information, click "Finish".

After creation is complete, you will see this Extension's folder in the project, the structure is similar to the following, this folder is used to store the implementation code of the screen sharing feature:

2 Set up Extension

1. Ensure that in the Extension's "Info.plist" file, "RPBroadcastProcessMode" is set to "RPBroadcastProcessModeSampleBuffer".
2. Import ZEGO Express SDK in Extension. For details, please refer to "Import SDK" in Quick Start - Integration.

3 Start screen sharing

If users need to share the entire system's screen and audio, they can call the startScreenCapture interface to enable screen sharing.

ZegoScreenCaptureConfig *config = [[ZegoScreenCaptureConfig alloc] init];
config.captureVideo = true;
config.captureAudio = true;
// Optional parameter, set the video capture area, must be within the original video data, unit is pixels (px)
config.cropRect = CGRectMake(x, y, width, height);
[ZegoExpressEngine.sharedEngine startScreenCapture:config];

ZegoScreenCaptureConfig *config = [[ZegoScreenCaptureConfig alloc] init];
config.captureVideo = true;
config.captureAudio = true;
// Optional parameter, set the video capture area, must be within the original video data, unit is pixels (px)
config.cropRect = CGRectMake(x, y, width, height);
[ZegoExpressEngine.sharedEngine startScreenCapture:config];

3.1 Set or update screen sharing orientation

Screen sharing orientation supports following system orientation and fixed orientation, default is following system orientation. You can set the orientation parameter in ZegoScreenCaptureConfig to set the screen sharing orientation.

ZegoScreenCaptureConfig *config = [[ZegoScreenCaptureConfig alloc] init];
...
config.orientation = ZegoScreenCaptureOrientationLandscape; // Fixed landscape
[ZegoExpressEngine.sharedEngine startScreenCapture:config];
// or Set when updating screen sharing config
[ZegoExpressEngine.sharedEngine updateScreenCaptureConfig:config];

ZegoScreenCaptureConfig *config = [[ZegoScreenCaptureConfig alloc] init];
...
config.orientation = ZegoScreenCaptureOrientationLandscape; // Fixed landscape
[ZegoExpressEngine.sharedEngine startScreenCapture:config];
// or Set when updating screen sharing config
[ZegoExpressEngine.sharedEngine updateScreenCaptureConfig:config];

4 Launch Extension process

There are two launch methods, please choose to implement according to your needs.

5 Get screen data

1. The system notifies Extension through the broadcastStartedWithSetupInfo callback that screen recording has started. You need to call the setupWithDelegate interface in the ZegoReplayKitExt class in this callback to create a data transmission channel:

   [ZegoReplayKitExt.sharedInstance setupWithDelegate:self];

   [ZegoReplayKitExt.sharedInstance setupWithDelegate:self];

2. In the processSampleBuffer system callback, send to ZEGO Express SDK through the sendSampleBuffer interface in the ZegoReplayKitExt class.

   [ZegoReplayKitExt.sharedInstance sendSampleBuffer:sampleBuffer withType:sampleBufferType];

   [ZegoReplayKitExt.sharedInstance sendSampleBuffer:sampleBuffer withType:sampleBufferType];

3. The system notifies Extension through the broadcastFinished callback that screen recording has ended. If screen recording fails, you can receive the reason for failure. You can call the finished interface in the ZegoReplayKitExt class in this callback to stop screen capture and disconnect the data transmission channel:

   [ZegoReplayKitExt.sharedInstance finished];

   [ZegoReplayKitExt.sharedInstance finished];

4. By calling the SDK's setupWithDelegate method above to initialize and set the delegate, you can add the <ZegoReplayKitExtHandler> protocol to the current class and implement callbacks to monitor the reason for screen sharing end or failure.

   - (void)broadcastFinished:(ZegoReplayKitExt *)broadcast reason:(ZegoReplayKitExtReason)reason {
   
       switch (reason) {
           case ZegoReplayKitExtReasonHostStop:
               {
                   NSDictionary *userInfo = @{NSLocalizedDescriptionKey : @"Host app stop srceen capture"};
                   NSError *error = [NSError errorWithDomain:NSCocoaErrorDomain code:0 userInfo:userInfo];
                   [self finishBroadcastWithError:error];
               }
               break;
           case ZegoReplayKitExtReasonConnectFail:
               {
                   NSDictionary *userInfo = @{NSLocalizedDescriptionKey : @"Connect host app fail need startScreenCapture in host app"};
                   NSError *error = [NSError errorWithDomain:NSCocoaErrorDomain code:0 userInfo:userInfo];
                   [self finishBroadcastWithError:error];
               }
               break;
           case ZegoReplayKitExtReasonDisconnect:
               {
                   NSDictionary *userInfo = @{NSLocalizedDescriptionKey : @"disconnect with host app"};
                   NSError *error = [NSError errorWithDomain:NSCocoaErrorDomain code:0 userInfo:userInfo];
                   [self finishBroadcastWithError:error];
               }
               break;
       }
   }

   - (void)broadcastFinished:(ZegoReplayKitExt *)broadcast reason:(ZegoReplayKitExtReason)reason {
   
       switch (reason) {
           case ZegoReplayKitExtReasonHostStop:
               {
                   NSDictionary *userInfo = @{NSLocalizedDescriptionKey : @"Host app stop srceen capture"};
                   NSError *error = [NSError errorWithDomain:NSCocoaErrorDomain code:0 userInfo:userInfo];
                   [self finishBroadcastWithError:error];
               }
               break;
           case ZegoReplayKitExtReasonConnectFail:
               {
                   NSDictionary *userInfo = @{NSLocalizedDescriptionKey : @"Connect host app fail need startScreenCapture in host app"};
                   NSError *error = [NSError errorWithDomain:NSCocoaErrorDomain code:0 userInfo:userInfo];
                   [self finishBroadcastWithError:error];
               }
               break;
           case ZegoReplayKitExtReasonDisconnect:
               {
                   NSDictionary *userInfo = @{NSLocalizedDescriptionKey : @"disconnect with host app"};
                   NSError *error = [NSError errorWithDomain:NSCocoaErrorDomain code:0 userInfo:userInfo];
                   [self finishBroadcastWithError:error];
               }
               break;
       }
   }