agora_doc_source/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita at 7e1d55f8154eed732eeb38e1e81408f3fc81be7d · AgoraIO/agora_doc_source · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_channelmediarelayconfiguration_setdestchannelinfo">
    <title><ph keyref="setDestChannelInfo"/></title>
    <shortdesc id="short"><ph id="shortdesc">设置目标频道信息。</ph></shortdesc>
    <prolog>
        <metadata>
            <keywords>
                <indexterm keyref="setDestChannelInfo"/>
            </keywords>
        </metadata>
    </prolog>
    <refbody>
        <section id="prototype">
            <p outputclass="codeblock">
            <codeblock props="android" outputclass="language-java">public void setDestChannelInfo(String channelName, ChannelMediaInfo destInfo) {
  if (destInfos.size() &lt; Constants.MAX_CROSS_DEST_CHANNEL_SIZE) {
    destInfos.put(channelName, destInfo);
  }
}</codeblock>
            <codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)setDestinationInfo:(AgoraChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName;
</codeblock>
            <codeblock props="cpp" outputclass="language-cpp"/>
            <codeblock props="cs" outputclass="language-csharp"/>
            <codeblock props="electron" outputclass="language-typescript"/>
            <codeblock props="unity" outputclass="language-csharp"/>
            <codeblock props="rn" outputclass="language-typescript"/>
           <codeblock props="flutter" outputclass="language-dart"/>
            <codeblock props="unreal" outputclass="language-cpp"></codeblock></p>
        </section>
        <section id="parameters">
            <title>参数</title>
            <parml>
            <plentry>
                <pt>channelName</pt>
                <pd>目标频道的频道名。</pd>
            </plentry>
            <plentry>
                <pt props="android">destInfo</pt>
                <pt props="ios mac">destinationInfo</pt>
                <pd>
                    <p>目标频道信息 <apiname keyref="ChannelMediaInfo"/>，包含如下成员：
                    <ul>
                    <li> <parmname>channelName</parmname> ：目标频道的频道名。</li>
                    <li>
                        <parmname>token</parmname>：能加入目标频道的 <parmname>token</parmname>。由你在 <parmname>destInfos</parmname> 中设置的 <parmname>channelName</parmname> 和 <parmname>uid</parmname> 生成。
                        <ul>
                        <li>如未启用 App Certificate，可直接将该参数设为默认值 <codeph><ph keyref="NULL"/></codeph>，表示 SDK 填充 App ID。</li>
                        <li>如已启用 App Certificate，则务必填入使用 <parmname>channelName</parmname> 和 <parmname>uid</parmname> 生成的 <parmname>token</parmname>。</li>
                        </ul> <note type="attention"><p>由于目标频道中任意频道的 token 过期会导致所有跨频道推流停止，因此建议你将目标频道的 token 设置为相同的过期时长。</p></note></li>
                    <li>
                        <parmname>uid</parmname>：标识目标频道中的转发媒体流的 UID。取值范围为 0 到（2 <sup>32</sup>-1），请确保与目标频道中的所有 UID 不同。默认值为 0，表示 SDK 随机分配一个 UID。</li>
                    </ul> </p>
                </pd>
            </plentry>
            </parml> </section>
        <section id="return_values" props="ios mac">
            <ul>
            <li><codeph><ph keyref="true"/></codeph>：方法调用成功。</li>
            <li><codeph><ph keyref="false"/></codeph>：方法调用失败。</li>
            </ul>
        </section>
    </refbody>
</reference>