# Topic (/zh-CN/api-reference/rtm/android/topic) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). Topic 是 Stream Channel 中的数据流管理机制。用户可以在 Stream Channel 中利用此特性进行数据流的订阅、分发、事件通知等。 :::info[信息] Topic 只存在于 Stream Channel。所以用户在使用相关特性之前,需要先创建一个 `StreamChannel` 对象实例。 ::: 想要了解 Topic 的更多特性,可以查看: - [Topic](/zh-CN/realtime-media/rtm/build/channels-and-topics/topics/topic-basic) ## joinTopic [#jointopic] ### 接口描述 [#接口描述] 加入 Topic 的目的在于注册成为该 Topic 的消息发布者之一,从而让用户具备发送消息的能力。是否执行该操作都不影响该用户是否成为该 Topic 的订阅者。 :::info[信息] - 当前 RTM 支持单客户端在同一个 Stream Channel 中同时加入 8 个 Topic。 - 在执行此操作之前,用户需要首先创建 `StreamChannel` 对象实例,并调用 `join` 方法加入频道,详见[频道](/zh-CN/realtime-media/rtm/build/channels-and-topics/channel-basic)。 ::: 成功加入 Topic 后,订阅该 Topic 并添加事件监听的用户会收到 `REMOTE_JOIN` 类型的 `onTopicEvent` 事件通知。详见[事件监听](/zh-CN/api-reference/rtm/android/configuration#事件监听)。 ### 接口方法 [#接口方法] 你可以通过以下方式调用 `joinTopic` 方法: ```java void StreamChannel.joinTopic( String topicName, JoinTopicOptions options, ResultCallback resultCallback ); ``` | 参数 | 类型 | 是否必填 | 默认值 | 描述 | | --- | --- | --- | --- | --- | | `topicName` | String | 必填 | - | Topic 名称。 | | `options` | `JoinTopicOptions` | 必填 | - | 加入 Topic 选项。 | | `resultCallback` | `ResultCallback` | 必填 | - | [topic-android-html-0-3-4 details](#table-slot-topic-android-html-0-3-4) | **topic-android-html-0-3-4 details** 调用结果回调: - 调用成功:执行 `onSuccess` 方法。 - 调用失败:执行 `onFailure` 方法。 `options` 参数包含以下属性: | 属性 | 类型 | 是否必填 | 默认值 | 描述 | | ------------ | -------------- | ----- | ---------------- | ----------- | | `messageQos` | `RtmMessageQos` | 选填 | `UNORDERED` | 定义此 Topic 中传输数据是否保序。详见 [`RtmMessageQos`](/zh-CN/api-reference/rtm/android/enumv#messageqos)。 | | `priority` | `RtmMessagePriority` | 选填 | `NORMAL` | 定义此 Topic 中传输数据的优先级(相比于同频道中的其他 Topic)。详见 [`RtmMessagePriority`](/zh-CN/api-reference/rtm/android/enumv#messagepriority)。 | | `topicMeta` | String | 选填 | - | 加入 Topic 时携带的其他辅助信息。 | | `syncWithMedia` | boolean | 选填 | `false` | 此 Topic 中发送的数据是否与共频道的 RTC 音视频数据流实现数据同步(时间戳对齐)。 | ### 基本用法 [#基本用法] ```java JoinTopicOptions options = new JoinTopicOptions(); options.messageQos = RtmMessageQos.ORDERED; streamChannel.joinTopic("topic_name", options, new ResultCallback() { @Override public void onSuccess(Void responseInfo) { log(CALLBACK, "join topic success"); } @Override public void onFailure(ErrorInfo errorInfo) { log(ERROR, errorInfo.toString()); } }); ``` ## publishTopicMessage [#publishtopicmessage] ### 接口描述 [#接口描述-1] `publishTopicMessage` 方法用于向 Topic 发送消息,频道中订阅此 Topic 及此消息发布者的用户会在 100 毫秒内收到此消息。调用 `publishTopicMessage` 方法需要用户首先加入 Stream Channel 并且通过调用 `joinTopic` 方法注册成为该 Topic 的消息发布者。 用户发送的消息在传输的过程中会被 TLS 加密,数据链路加密默认开启且无法关闭。用户也可以在出初始化的时候开启端侧加密,以获得更高的数据安全等级,详见[初始配置](/zh-CN/api-reference/rtm/android/configuration)。 ### 接口方法 [#接口方法-1] 你可以通过以下方式调用 `publishTopicMessage` 方法: ```java // publishTopicMessage [1/2] void StreamChannel.publishTopicMessage( String topicName, String message, TopicMessageOptions options, ResultCallback resultCallback ); ``` ```java // publishTopicMessage [2/2] void StreamChannel.publishTopicMessage( String topicName, byte[] message, TopicMessageOptions options, ResultCallback resultCallback ); ``` | 参数 | 类型 | 是否必填 | 默认值 | 描述 | | --- | --- | --- | --- | --- | | `topicName` | String | 必填 | - | Topic 名称。 | | `message` | String/byte[] | 必填 | - | 消息负载。 | | `options` | `TopicMessageOptions` | 必填 | - | 消息选项。 | | `resultCallback` | `ResultCallback` | 必填 | - | [topic-android-html-1-4-4 details](#table-slot-topic-android-html-1-4-4) | **topic-android-html-1-4-4 details** 调用结果回调: - 调用成功:执行 `onSuccess` 方法。 - 调用失败:执行 `onFailure` 方法。 `TopicMessageOptions` 数据类型包含以下属性: | 属性 | 类型 | 是否必填 | 默认值 | 描述 | | --------- | --- | ----- | --- | --------- | | `sendTs` | long | 选填 | `0` | 消息发送时间戳。该参数在 Message Channel 中无效。 | | `customType` | String | 选填 | - | 用户自定义字段。仅支持 String 型。 | ### 接口方法 [#接口方法-2] 示例 1:向指定频道发送 String 消息 ```java String message = "message"; TopicMessageOptions options = new TopicMessageOptions(); options.customType = "PlainTxT"; streamChannel.publishTopicMessage("topic_name", message, options, new ResultCallback() { @Override public void onSuccess(Void responseInfo) { log(CALLBACK, "publish topic message success"); } @Override public void onFailure(ErrorInfo errorInfo) { log(ERROR, errorInfo.toString()); } }); ``` 示例 2:向指定频道发送 Byte 消息 ```java byte[] message = new byte[] {1, 2, 3, 4}; TopicMessageOptions options = new TopicMessageOptions(); options.customType = "ByteArray"; streamChannel.publishTopicMessage("topic_name", message, options, new ResultCallback() { @Override public void onSuccess(Void responseInfo) { log(CALLBACK, "publish topic message success"); } @Override public void onFailure(ErrorInfo errorInfo) { log(ERROR, errorInfo.toString()); } }); ``` ## leaveTopic [#leavetopic] ### 接口描述 [#接口描述-2] 当你不再需要向某个 Topic 发布消息,你可以调用 `leaveTopic` 方法取消注册为该 Topic 的消息发布者,从而释放资源。该方法不影响你是否订阅该 Topic,也不影响其他用户对该 Topic 的任何操作。 成功调用该方法后,订阅该频道并开启事件监听的用户会收到 `REMOTE_LEAVE` 类型的 `onTopicEvent` 事件通知,详见 [事件监听](/zh-CN/api-reference/rtm/android/configuration#事件监听)。 ### 接口方法 [#接口方法-3] 你可以通过以下方式调用 `leaveTopic` 方法: ```java void StreamChannel.leaveTopic(String topicName, ResultCallback resultCallback); ``` | 参数 | 类型 | 是否必填 | 默认值 | 描述 | | --- | --- | --- | --- | --- | | `topicName` | String | 必填 | - | Topic 名称。 | | `resultCallback` | `ResultCallback` | 必填 | - | [topic-android-html-2-2-4 details](#table-slot-topic-android-html-2-2-4) | **topic-android-html-2-2-4 details** 调用结果回调: - 调用成功:执行 `onSuccess` 方法。 - 调用失败:执行 `onFailure` 方法。 ### 基本用法 [#基本用法-1] ```java streamChannel.leaveTopic("topic_name", new ResultCallback() { @Override public void onSuccess(Void responseInfo) { log(CALLBACK, "leave topic success"); } @Override public void onFailure(ErrorInfo errorInfo) { log(ERROR, errorInfo.toString()); } }); ``` ## subscribeTopic [#subscribetopic] ### 接口描述 [#接口描述-3] 加入频道后,你可以调用 `subscribeTopic` 方法订阅该频道中 Topic 的消息发布者。 `subscribeTopic` 为增量方法。例如,第一次调用该方法时,订阅消息发布者列表为 `[UserA, UserB]`,第二次调用该方法时,订阅消息发布者列表为 `[UserB, UserC]`,则最后成功订阅的结果是 `[UserA, UserB, UserC]`。 同一个用户在同一个频道中最多只能同时订阅 50 个 Topic,且每个 Topic 中最多只能订阅 64 个消息发布者。详见 [API 调用限制](/zh-CN/realtime-media/rtm/reference/usage-limits-and-errors/api-limits)。 ### 接口方法 [#接口方法-4] 你可以通过以下方式调用 `subscribeTopic` 方法: ```java void StreamChannel.subscribeTopic( String topicName, TopicOptions options, ResultCallback resultCallback ); ``` | 参数 | 类型 | 是否必填 | 默认值 | 描述 | | --- | --- | --- | --- | --- | | `topicName` | String | 必填 | - | Topic 名称。 | | `options` | `TopicOptions` | 必填 | - | 订阅 Topic 选项。 | | `resultCallback` | `ResultCallback` | 必填 | - | [topic-android-html-3-3-4 details](#table-slot-topic-android-html-3-3-4) | **topic-android-html-3-3-4 details** 调用结果回调: - 调用成功:执行 `onSuccess` 方法并返回 `SubscribeTopicResult` 数据类型。 - 调用失败:执行 `onFailure` 方法。 `options` 参数包含以下属性: | 属性 | 类型 | 是否必填 | 默认值 | 描述 | | ---- | ---------------- | ----- | --- | --------- | | `users` | `ArrayList` | 选填 | - | 需要订阅的消息发布者(Publisher)的 `UserId` 列表,如果不设置,则默认随机订阅不超过 64 个用户。 | `SubscribeTopicResult` 参数包含如下属性: | 属性 | 类型 | 描述 | | ------------- | ---------------- | ----- | | `succeedUsers` | `ArrayList` | 订阅成功的用户列表。 | | `failedUsers` | `ArrayList` | 订阅失败的用户列表。 | ### 基本用法 [#基本用法-2] 示例 1:订阅 Topic 中指定的消息发布者 ```java TopicOptions options = new TopicOptions(); options.users = new ArrayList<>(Arrays.asList("UserA","UserB","UserC")); streamChannel.subscribeTopic("topic_name", options, new ResultCallback() { @Override public void onSuccess(SubscribeTopicResult responseInfo) { log(CALLBACK, "subscribe topic success"); } @Override public void onFailure(ErrorInfo errorInfo) { log(ERROR, errorInfo.toString()); } }); ``` 示例 2:随机订阅 Topic 中的 64 个消息发布者 ```java TopicOptions options = new TopicOptions(); mStreamChannel.subscribeTopic("topic_name", options, new ResultCallback() { @Override public void onSuccess(SubscribeTopicResult responseInfo) { log(CALLBACK, "subscribe topic success"); } @Override public void onFailure(ErrorInfo errorInfo) { log(ERROR, errorInfo.toString()); } }); ``` ## unsubscribeTopic [#unsubscribetopic] ### 接口描述 [#接口描述-4] 如果你对某个 Topic 不再感兴趣,或者不再需要订阅 Topic 中的一个或多个消息发布者,你可以调用 `unsubscribeTopic` 方法取消订阅该 Topic 或取消订阅该 Topic 中指定的消息发布者。 ### 接口方法 [#接口方法-5] 你可以通过以下方式调用 `unsubscribeTopic` 方法: ```java void StreamChannel.unsubscribeTopic( String topicName, TopicOptions options, ResultCallback resultCallback ); ``` | 参数 | 类型 | 是否必填 | 默认值 | 描述 | | --- | --- | --- | --- | --- | | `topicName` | String | 必填 | - | Topic 名称。 | | `options` | `TopicOptions` | 必填 | - | 取消订阅 Topic 选项。 | | `resultCallback` | `ResultCallback` | 必填 | - | [topic-android-html-4-3-4 details](#table-slot-topic-android-html-4-3-4) | **topic-android-html-4-3-4 details** 调用结果回调: - 调用成功:执行 `onSuccess` 方法。 - 调用失败:执行 `onFailure` 方法。 `options` 参数包含以下属性: | 属性 | 类型 | 是否必填 | 默认值 | 描述 | | ---- | ----- | ----- | --- | ------- | | `users` | `ArrayList` | 选填 | - | 需要取消订阅的消息发布者(Publisher)的 `UserId` 列表,如果不设置,则默认随机取消订阅不超过 64 个用户。 | ### 基本用法 [#基本用法-3] 示例 1:取消订阅 Topic 中指定的消息发布者 ```java TopicOptions options = new TopicOptions(); options.users = new ArrayList<>(Arrays.asList("Tony","Bo")); streamChannel.unsubscribeTopic("topicName", options, new ResultCallback() { @Override public void onSuccess(Void responseInfo) { log(CALLBACK, "unsubscribe topic success"); } @Override public void onFailure(ErrorInfo errorInfo) { log(ERROR, errorInfo.toString()); } }); ``` 示例 2:随机取消订阅 Topic 中的 64 个消息发布者 ```java TopicOptions options = new TopicOptions(); streamChannel.unsubscribeTopic("topicName", options, new ResultCallback() { @Override public void onSuccess(Void responseInfo) { log(CALLBACK, "unsubscribe topic success"); } @Override public void onFailure(ErrorInfo errorInfo) { log(ERROR, errorInfo.toString()); } }); ```