Record Meeting - iOS
VideoSDK allows you to record video & audio during the meeting. The recording files are available in developer dashboard or you can also choose to store them in your own cloud storage.
VideoSDK also allows you to configure the recording layouts in numerous ways like by simply setting different prebuilt layouts in the configuration or by providing your own custom template to do the recording according to your layout choice.
This guide will provide an overview of how to implement start and stop Meeting Recording.
To initiate automatic recording at the beginning of a session
, simply provide the autoStartConfig
feature recording
during room
creation. For more information on configuring the autoStartConfig
, please refer to the provided documentation here.
startRecording()
startRecording()
can be used to start a recording of the meeting which can be accessed from the Meeting
class. This method accepts three parameters:
1. webhookUrl
: This would the webhook URL where you would like to listen to event happening for the recording like starting and stopping of recording. It will be triggered when the recording is completed and stored into server. Read more about webhooks here2. awsDirPath
: This parameter accepts the path for the your S3 bucket where you want to store recordings to. To allow us to store recording in your S3 bucket, you will need to fill this form by providing the required values. VideoSDK AWS S3 Integration3. config
: This parameter will define how the meeting should be recorded.
If you don't have a value for webhookUrl
,awsDirPath
or config
, you should pass null
in place of the missing value. If you pass null
in awsDirPath
parameter then by default recordings will be store on the VideoSDK's storage.
- Swift
class MeetingViewController {
// button to start recording the meeting
@IBAction func recordMeetingButtonTapped(_ sender: Any) {
self.meeting?.startRecording(webhookUrl: "<your webhook-url>",
awsDirPath: "<your awsDirPath>"
config: RecordingConfig(layout: ConfigLayout(type: .GRIDpriority: .SPEAKER, gridSize: 4),
theme: .DARK, mode: .video_and_audio,
quality: .high,
orientation: .portrait))
}
}
stopRecording()
stopRecording()
is used to stop the meeting recording which can be accessed from theMeeting
class.
Example
- Swift
class MeetingViewController {
// button to stop recording the meeting
@IBAction func stopRecordingButtonTapped(_ sender: Any) {
self.meeting?.stopRecording()
}
}
Event associated with Recording
- onRecordingStateChanged - Whenever meeting recording state changes, then
onRecordingStateChanged
event will trigger.
- Swift
extension MeetingViewController: MeetingEventListener {
//recording event
func onRecordingStateChanged(state: RecordingState) {
switch(state) {
case .RECORDING_STARTING:
print("recording starting")
case .RECORDING_STARTED:
print("recording started")
case .RECORDING_STOPPING:
print("recording stopping")
case .RECORDING_STOPPED:
print("recording stopped")
}
}
}
Storage Configuration
While recording your meetings, you can choose to store them on the VideoSDK's storage or you can also configure your own AWS S3 Storage, Azure Blob or GCP Cloud Storage
to store the meeting recordings directly on your storage.
You can configure your own AWS S3 Storage, Azure Blob or GCP Cloud Storage
from the VideoSDK Dashboard's API section.
You can also go through this guide to setup the storage or watch this video to configure your storage.
Custom Template
With VideoSDK, you can also use your own custom designed layout template to record the meetings. In order to use the custom template, you need to create a template for which you can follow this guide. Once you have setup the template, you can use the REST API to start the recording with the templateURL
parameter.
API Reference
The API references for all the methods utilised in this guide are provided below.
Got a Question? Ask us on discord