Closed Captioning

The iOS Client SDK supports automatically generated closed captioning for meetings. Closed captioning is a service where the meeting participants can able to see the closed captions (subtitles) during the meeting, the meeting audio will be converted to text by using speech-to-text services. 

The closedCaptioningService allows meeting participants to see the closed captions during the meeting. iOS Client SDK provides the ability to enable or disable closed captions during the meeting.

Note 

The closed captioning setting must be enabled in your meeting. Currently, the iOS Client SDK supports only English.

Pre-requisites

A closed captioning service is not available for all meetings. The availability of closed captioning services may vary depending on the account of the meeting organizer and its enterprise. You can use isClosedCaptioningAvailable to see if that feature is available for your account.

In case you find it is not available at your meeting, please contact your enterprise admin and get the feature enabled through the BlueJeans support team.

Manage Closed Captioning

The iOS Client SDK provides the ability to check the availability of the closed captioning service. 

BlueJeansSDK.meetingService.closedCaptioningServiceProtocol.isClosedCaptioningAvailable()

Note 

  • To enable a feature that is not available on your account, please contact your enterprise admin and get the feature enabled through the BlueJeans support team.
  • Once the API has been executed, you returned the closed captioning that can be used. 

To start closed captioning service in your meetings, use the following command.

BlueJeansSDK.meetingService.closedCaptioningService.startClosedCaptioning()

Note:

  • If the meeting schedule option is enabled for the closed captioning feature, you can start closed captioning in the meeting.
  • Caption text can be displayed via the closedCaptionText property.

Run the following command to check whether the closed captioning service is active or not. This API is a Boolean property, that returns "true" when the closed captioning service is active or "false" when the closed captioning service is inactive.

BlueJeansSDK.meetingService.closedCaptioningService.isClosedCaptioningOn()

Use the following command to stop the closed captioning service.

BlueJeansSDK.meetingService.closedCaptioningService.stopClosedCaptioning()

User experience recommendation

  • Use the isClosedCaptioningAvailable property to check the availability of closed captioning service. Closed captioning services can be enabled or disabled with scheduling options or the meeting features associated with your account.
  • closedCaptionText API provides the closed-captioning text in the meeting environment.
  • You can check the current state of close captioning with the closedCaptioningState API.