diff --git a/media-push/develop/integration-best-practices.mdx b/media-push/develop/integration-best-practices.mdx index 0201d9db6..cd8868e90 100644 --- a/media-push/develop/integration-best-practices.mdx +++ b/media-push/develop/integration-best-practices.mdx @@ -118,11 +118,21 @@ When creating a converter with a `create` call, pay attention to the following: - Agora recommends that you assign the name using a combination of the channel name and a converter property. For example, `show68_horizontal` and `show68_vertical` would represent a horizontal and a vertical layout respectively. - `audioOption` and `videoOptions` are set as follows for audio only or video only scenarios: - In a video only scenario, you do not need to set `audioOptions` and its related fields. - - In a audio only scenario, you do not need to set `videoOptions` and their related fields. + - In an audio-only scenario, you do not need to set `videoOptions` and its related fields by default. For special cases, see [Output SEI in audio-only scenarios](#output-sei-in-audio-only-scenarios). - In audio plus video scenarios, `videoOptions` and `audioOptions` are required and cannot be left blank. If you do not need to configure `audioOptions` set it to `null`. - Set an appropriate value for `idleTimeout`. The default value of 300 seconds is recommended. It means that the converter is automatically destroyed, 300 seconds after all subscribers leave the channel. +### Output SEI in audio-only scenarios + +In an audio-only scenario, by default, you do not need to set `videoOptions` and its related fields. However, if you need to carry additional user information, such as volume, you can set SEI information with the `seiOptions` field in `videoOptions`. + +If you want to output SEI information in Metadata or DataStream type carried by the user in an audio-only scenario and avoid video transcoding fees, follow these steps: + +1. Pass the SEI information to be output in `videoOptions.seiOptions`. +1. Ensure that the `width` and `height` in `videoOptions.canvas` are set to `16` to avoid video transcoding fees. +1. Pass the UID of the user who carries the SEI information in `rtcStreamUid` field in `videoOptions.layout`. + ## Update RTMP converter When updating a specified converter with an `Update` call, pay attention