/ReplayKitUnityBridge

A bridge created from iOS to Unity - exposing the Cocoa ReplayKit API. It allows you to record the screen, set a limited time for the screen to be recorded, and receive a file of the recorded session

Primary LanguageASPMIT LicenseMIT

license

Summary

This is a Unity plugin for iOS that allows you to record the screen and capture gameplay. It includes the Xcode project that it was built in. To start using it, simply drag the PluginSource folder into your Unity project as a sub-folder in the following directory/file path: Assets > Plugins > iOS > ReplayKitUnity > Drag the source and editor folders into here

Blog Post describing the steps to make a bridge: https://medium.com/@SoCohesive/unity-how-to-build-a-bridge-ios-to-unity-with-swift-f23653f6261

Disclaimer:

This plugin is a work in progress and has been built to show the steps of creating a Unity iOS plugin using Swift

Features

  • Record Screen
  • Stop recording of screen
  • Recieve video file (.mp4) of recording
  • Set a restricting time to allow for recording the screen
  • A record button and progress bar of your recording playback that is excluded from the screen recording
  • Share the recorded file via the standard iOS share sheet (mail, twitter, facebook)

Requirements

  • iOS 11.0 or later

Getting Started

  • Go to the "Demo" folder, Main Scene. View the RecordController script for sample code

Communication

  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, submit a pull request.

Installation

  • Open the Plugin Source folder, Drag the "Source" and "Editor" folder into your Unity project.
  • It must be dragged into the following Unity file path : Assets > Plugins > iOS > ReplayKitUnity

How To Use

  1. Start a screen recording
ReplayKitUnity.StartRecording();
  1. Stop the screen recording
ReplayKitUnity.StopRecording();
  1. Get the video file after recording is complete

a) Subscribe to the onStopCaptureWithFile action in ReplayKitUnity

ReplayKitUnity.Instance.onStopCaptureWithFile += OnStopRecording; (connect to your function)

b) Use the VideoPlayer Unity componnent or any video playback technique to play the .mp4

  1. Get notified when the recording has started
ReplayKitUnity.Instance.onStartRecording += OnStartRecording; (connect to your function)
  1. Set a constrained time to record gameplahy (ie - only 10 seconds)
ReplayKitUnity.AllowedTimeToRecord = 10.0f;
  1. Set the subject line for sharing the video file via email
ReplayKitUnity.MailSubjectText = "Check this recording of my game out!";

Contact：