Media Gateway features
Updated
Key capabilities and common use cases for Media Gateway.
Media Gateway enables users to push content to Agora SDRTN(R) using standard streaming protocols such as RTMP and SRT. The channel host automatically publishes this streamed content to the correct channel. With Media Gateway, you can employ advanced transcoding capabilities on media streams for enhanced distribution.
The following figure shows the overall architecture of Media Gateway:
Product features
| Feature | Description |
|---|---|
| Media input | Supports generating a streaming key through a RESTful API or a local encryption algorithm, then pushing the source stream directly to Agora's gateway service. After a successful push, the media stream is automatically played in the channel for remote users. |
| Multiple media streaming formats and protocols | Supports H.264 and H.265 video codecs, AAC audio codec, RTMP and SRT push protocols, and FLV and MPEG-TS media formats. |
| Custom transcoding parameters | Supports enabling transcoding for media streams input into the channel. If you enable transcoding, you can set parameters such as resolution, frame rate, bitrate, and whether to enable large and small streams. |
| Restricted access area | When activating Media Gateway, you specify the access area to ensure the transmission quality of the media stream. |
| Server event notification callback | Agora provides message notification services. After activating Media Gateway, you receive event notifications. |
Related APIs and implementation entry points
Use the following references when you implement the core Media Gateway capabilities described above:
- REST API overview: Review the base URL, authentication model, and the full API surface.
- RESTful authentication: Authenticate server-side requests before calling Media Gateway APIs.
- Query notification service IP address: Retrieve the callback IP ranges used by notification services.
The main API groups map to product features as follows:
| Feature area | APIs or guides |
|---|---|
| Media input and stream key management | Use the streaming key APIs in the REST API overview to create, query, and delete stream keys. For a local stream key generation example, see the Quickstart. |
| Online stream control | Use the online stream APIs in the REST API overview to query active streams, inspect stream details, force disconnect a stream, or mute and unmute audio or video. |
| Custom transcoding parameters | Use template APIs in the REST API overview to create, update, delete, or set default transcoding templates for ingress streams. |
| Server event notification callback | Configure notifications by following Receive notifications about channel events, then use the event type reference to interpret callback payloads. |
Applicable use cases
| Use case | Description |
|---|---|
| Commentary from influencers and celebrities | Inject high-definition video streams into interactive channels. Multiple hosts can watch and interact in real time from different places. |
| Low-latency distribution | Distribute content to viewers faster and more reliably than with a CDN. |
| Recording and live broadcasting | A teacher records content in advance and injects it into a live classroom. Students and teaching assistants can watch the content and interact in real time. |
| 24-hour chat room | Background music is played continuously and is not interrupted when switching hosts. |