# undefined (/zh-CN/introduction/terms/%E4%B8%AD%E6%96%87%E7%BF%BB%E8%AF%91/%E5%9B%BA%E5%AE%9A%E7%94%A8%E6%B3%95/%E5%9B%BA%E5%AE%9A%E7%94%A8%E6%B3%95-RTC) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). --- --- ## C++ return_value 返回值描述 [#c-return_value-返回值描述] 结合 api_signature 和返回值的注释,根据实际情况对 return_value 字段中返回值的描述按照下列示例进行润色: - 如果没有返回值,return_value 字段留空。 - 如果返回值是 bool 类型,则分别解释 true 和 false 的含义,按照下列示例来描述: ### bool 类型的返回值示例 [#bool-类型的返回值示例] “- `true`:xx 成功。\n- `false`:xx 失败。” ### - 如果该方法的返回值为 0 和小于 0,按照下列示例来描述: ### 示例 [#示例] - 0: 方法调用成功。\n- < 0: 方法调用失败。 ### - 如果该方法的返回值是一个对象或实例,按照下列示例来描述: ### 示例 [#示例-1] - 方法调用成功,返回 xxx 对象/实例。 ### 注意:xxx 对象,xxx 需要添加 code font。 - 如果该方法的返回值是一个指针型的返回值,按照下列示例来描述: ### 示例 [#示例-2] - 方法调用成功,返回 xxx。\n- 方法调用失败,返回空指针。 ### - 如果该方法的返回值是一个字符串型的返回值,按照下列示例来描述: ### 示例 [#示例-3] - 方法调用成功时,返回 xxx。\n- 方法调用失败,返回空字符串。 ### - 如果该方法的返回值是 int 型且不会返回负值,按照下列示例来描述: ### 示例 [#示例-4] 方法调用成功,返回 xxx。 ### ### 示例 [#示例-5] - 0: 方法调用成功。\n- < 0: 方法调用失败。 - 方法调用成功时,返回 xxx。\n- < 0: 方法调用失败。 ## exception 异常 [#exception-异常] 如果 Android API 会抛出异常,请按照下列示例来描述: ### 示例 [#示例-6] ”xx 失败,SDK 会抛出异常,并返回相应的错误信息。你需要捕获异常并进行处理。“ ## Error \*err 参数描述 [#error-err-参数描述] 如果播放器相关方法中有 Error \*err 参数,则参数 desc 描述中先增加下列描述,如果原文注释中还有其他信息,再补充: ### 描述 [#描述] 状态或错误信息,详见 `Error`。 ## cb 参数描述 [#cb-参数描述] 如果参数的类型是 “std::function”,参数 desc 按照下列示例来描述: ### 示例 [#示例-7] 异步通知切换操作结果的回调。你可以通过该回调的 `err` 参数得知操作的结果或错误码信息,详见 `Error`。 ## RTC 描述 [#rtc-描述] RTC(全大写)是产品名称,在描述中出现时无需添加 code font。 ## objective-c return_value 返回值描述 [#objective-c-return_value-返回值描述] 结合 api_signature 和返回值的注释,根据实际情况对 return_value 字段中返回值的描述按照下列示例进行润色: - 如果没有返回值,即方法声明为`(void)` ,return_value 字段留空。 - 结合 api_signature 判断,如果方法签名包含(BOOL),则分别解释 YES 和 NO 的含义,按照下列示例来描述: ### bool 类型的返回值示例 [#bool-类型的返回值示例-1] “- `YES`:xx 成功。\n- `NO`:xx 失败。” ### - 结合 api_signature 判断,如果该方法的返回值是含状态码的 NSInteger,且返回值为 0 和小于 0,按照下列示例来描述: ### 示例 [#示例-8] - 0: 方法调用成功。\n- < 0: 方法调用失败。 ### - 结合 api_signature 判断,如果该方法的返回值是一个对象,按照下列示例来描述: ### 示例 [#示例-9] 方法调用成功,返回 xxx 对象。 ### 注意:xxx 对象,xxx 需要添加 code font。 - 结合 api_signature 判断,如果该方法的返回值是含状态码的 NSInteger,且不会返回负值,按照下列示例来描述: ### 示例 [#示例-10] 方法调用成功,返回 xxx。 ### - 结合 api_signature 判断,如果该方法的返回值是容器型返回值,按照下列示例来描述: ### 示例 [#示例-11] - 方法调用成功,返回 xxx。\n- 方法调用失败,返回 xxx。 ### ## Java return_value 返回值描述 [#java-return_value-返回值描述] 结合 api_signature 和返回值的注释,根据实际情况对 return_value 字段中返回值的描述按照下列示例进行润色: - 如果没有返回值。即方法返回类型为`void`,return_value 字段留空。 - 结合 api_signature 判断,如果返回值是 boolean 类型,则分别解释 true 和 false 的含义,按照下列示例来描述: ### boolean 类型的返回值示例 [#boolean-类型的返回值示例] “- `true`:xx 成功。\n- `false`:xx 失败。” ### - 结合 api_signature 判断,如果该方法的返回值为含错误码的 int 返回值,按照下列示例来描述: ### 示例 [#示例-12] - 0: 方法调用成功。\n- < 0: 方法调用失败。 ### - 结合 api_signature 判断,如果该方法的返回值是一个对象或实例,按照下列示例来描述: ### 示例 [#示例-13] - 方法调用成功,返回 xxx 对象/实例。 ### 注意:xxx 对象,xxx 需要添加 code font。 - 结合 api_signature 判断,如果该方法的返回值是集合型返回值,按照下列示例来描述: ### 示例 [#示例-14] - 方法调用成功,返回 xxx。\n- 方法调用失败,返回 xxx。 ### - 结合 api_signature 判断,如果该方法的返回值是一个字符串型的返回值,按照下列示例来描述: ### 示例 [#示例-15] - 方法调用成功时,返回 xxx。\n- 方法调用失败,返回空字符串。 ### - 结合 api_signature 判断,如果该方法的返回值是非负整型,按照下列示例来描述: ### 示例 [#示例-16] 方法调用成功,返回 xxx。 ### ## connection 参数描述 [#connection-参数描述] connection 参数的描述按照下列示例来描述: ### 示例 [#示例-17] Connection 信息。详见 `{参数类型}`。