Vonage Video API Developer Guides
Learn the details of building on the Vonage Video API platform.
Basic Vonage Video API functionality
| Creating a session | Overview Java | PHP | Python | Ruby | Node.js | .NET | Create a Vonage Video API session that clients can connect to, publish streams to, and subscribe to streams within. |
| Creating a token | Overview Java | PHP | Python | Ruby | Node.js | .NET | Create a token that grants a client access to a session. |
| Joining a session | Web | iOS | iOS (Swift) | Android | Windows | macOS | Linux | React Native | Connect to and disconnect from Vonage Video API sessions, and find out when other clients have connected and disconnected. |
| Publishing a stream | Web | iOS | iOS (Swift) | Android | Windows | macOS | Linux | React Native | Publish a video and audio stream in a session that others can view by subscribing to it. |
| Subscribing to a stream | Web | iOS | iOS (Swift) | Android | Windows | macOS | Linux | React Native | View the video and audio stream published by another. |
Customization
| Adjusting audio and video | Web | iOS | iOS (Swift) | Android | Windows | macOS | Linux | React Native | Toggle video and audio in a stream. |
| Customizing the UI | Web | iOS | iOS (Swift) | Android | Windows | Configure the appearance of Vonage Video API elements. |
| Configuring publisher video constraints | Web | Update a publisher's preferred video resolution and frame rate. |
Advanced Features
| Using the Vonage Media Processor | Overview Web | iOS | iOS (Swift) | Android | Windows | macOS | React Native | Use the Vonage Media Processor library to apply audio and video transformers to published streams. |
| Live captions | Overview Web | iOS | iOS (Swift) | Android | Windows | macOS | Linux | React Native | REST | Use the Live Captions API to transcribe audio streams and generate real-time captions for your application. |
| Experience Composer | Overview | Experience Composer captures immersive web application experiences, including whiteboards, chats, branding, and customer elements, for both video broadcast and recording. |
| Enterprise environment | Overview | Using the Video API Enterprise environment. |
| Screen sharing | Web | iOS | Android | Windows | React Native | Share your screen with other clients. |
| Monitoring sessions | Overview | Monitor session activity from your app server. |
| Service Disruption Callbacks | Overview | How to receive server-rotation session monitoring callbacks and recover connections, archives, broadcasts, Experience Composer, and Live Captions. |
| Client observability | Overview Web | iOS | iOS (Swift) | Android | Windows | macOS | Linux | React Native | Use the Vonage Video Client SDK Client Observability API to monitor real-time metrics across both sender and receiver. |
| Moderation | Overview Web | iOS | Android | Windows | macOS | Linux | React Native | REST | Remove clients, force them to stop publishing a stream, or mute a stream's audio. |
| Signaling | Overview Web | iOS | iOS (Swift) | Android | Windows | macOS | Linux | React Native | REST | Send text and data to other clients in the session. |
| Audio fallback | Overview Web | iOS | iOS (Swift) | Android | Windows | macOS | Linux | React Native | Prioritize audio in response to network quality. |
| Archiving | Overview | Record, save, and retrieve Vonage Video API sessions. |
| Post-Call Transcriptions | Overview | Generate post-call transcriptions from individual stream archives. |
| Broadcast | Overview | Share your Vonage Video API sessions with large audiences. |
| Audio Connector | Overview | Send audio from a Vonage Video API session to a WebSocket. |
| SIP Interconnect | Overview | Connect a Vonage Video API session to your SIP gateway. |
| Video Connector transport for Pipecat | Overview | Learn how to use Vonage Video Connector transport for Pipecat to build AI-powered applications. |
| Video Connector | Overview | Programmatically participate in Vonage Video API sessions as a server-side WebRTC participant with the ability to publish and subscribe to audio and video streams. |
| Voice | Overview | Optimizations for voice-only sessions. |
| End-to-End Encryption | Overview Web | iOS | iOS (Swift) | Android | Windows | macOS | Linux | React Native | Encrypt media being sent through a media server from your application. |
| Allowed IP list | Overview | The allowed IP list feature lets projects using the Enterprise environment know the IP addresses of Vonage Video API servers. |
Additional Resources
| A Smarter, Safer Video API | Overview | A narrative overview of smart, self-optimizing Video API features, with complete settings recipes for common use cases. |
| Insights API | Overview | Programmatically obtain metadata about your video calls. |
| Video codecs | Overview | Information on video codecs supported in the Vonage Video API. |
| Scalable video | Overview | Improve video quality in multi-party sessions. |
| Single Peer Connection | Overview | Multiplex all subscriber streams over a single peer connection to reduce network overhead, improve bandwidth management, and support better scalability. |
| Mobile guidelines | iOS | Android | React Native | Considerations when developing for a mobile device. |
| 1080p video | Overview | Considerations for using 1080p video streams. |
| Server rotation and session migration | Overview | Best practices for handling Video API server rotations and keeping clients connected when they occur. |
| Handling exceptions | Web | Important information on handling exceptions, including errors when connecting to a session or publishing. |
| Debugging during development | Web | iOS | iOS (Swift) | Android | React Native | Tips for building your app. |
| Security | Overview | Considerations when developing secure Vonage Video API apps. |
| Restricted Network Guidelines | Overview | A decision tree for deploying a Vonage Video API client in a restricted network. |
| Account management | Overview | Manage multiple projects in your Vonage Video API account. |
| Configurable TURN servers | Overview | Configure the TURN servers used by Vonage Video API clients. |
| Regional Media Zones | Overview | Restrict Vonage Video API media traffic to media servers hosted inside a specific regional zone. |
| IP Proxy | Overview | Use your own proxy server to route non-media traffic, such as Video API calls, WebSocket connections, and log traffic, within a highly restrictive network environment. |
| EU Proxy | Overview | Use the Vonage Video EU proxy server to route all non-media traffic, such as Video API calls, WebSocket connections, and log traffic, within the EU. |
| China Relay | Overview | DEPRECATED Use the Vonage Video China Relay to route all non-media traffic, such as Video API calls, WebSocket connections, and log traffic, within China. |
| Advanced media stream encryption | Overview | Use AES-256 encryption for media streams. |