Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEVX-6803: Adding Captions API #267

Merged
merged 4 commits into from
Sep 6, 2023
Merged

Conversation

superchilled
Copy link
Contributor

@superchilled superchilled commented Sep 5, 2023

Description

This PR does the following:

Implements the Captions API functionality. Specifically:

  • Implements a Caption class with start and stop wrapper functions
  • Updates the Client class to add start_live_captionsandstop_live_captionswhich are called by theCaptions` wrappers
  • Updates the Opentok class to add a captions method which returns a Captions object
  • Adds a OpenTokCaptionsError class
  • Adds unit tests for the new functionality

Motivation and Context

Adds a feature to the SDK which has recently gone GA in the API.

How Has This Been Tested?

Unit tests added for the new functionality.

Example Output or Screenshots (if appropriate):

n/a

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@superchilled superchilled marked this pull request as ready for review September 6, 2023 10:55
@superchilled
Copy link
Contributor Author

Hi @jeffswartz the Ruby SDK reference docs will need to be updated for this release. :)

Copy link

@maxkahan maxkahan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A thing of beauty ✨

@superchilled superchilled merged commit 23c6380 into main Sep 6, 2023
13 checks passed
@superchilled superchilled deleted the devx-6803-add-captions-api branch September 6, 2023 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants