@ray-js/api 1.7.83 → 1.7.84

package/@types/AIStreamKit.d.ts

@@ -1,13 +1,26 @@
 /**
  * AIStreamKit
  *
- * @version 2.2.14
+ * @version 2.2.15
  */
 declare namespace ty.aistream {
   /**
    * Get channel connection status
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.isConnected({
+   *   clientType: 1,
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isConnected(params: {
@@ -66,6 +79,19 @@ declare namespace ty.aistream {
    * Get channel connection status
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.isConnected({
+   *   clientType: 1,
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function isConnectedSync(params?: ConnectParams): {
@@ -95,6 +121,19 @@ declare namespace ty.aistream {
    * Initiate channel connection, will callback success directly if already connected
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.connect({
+   *   clientType: 1,
+   *   deviceId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function connect(params: {
@@ -138,6 +177,24 @@ declare namespace ty.aistream {
    * Query agent token, pass to createSession
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.queryAgentToken({
+   *   ownerId: "xx",
+   *   solutionCode: "xx",
+   *   api: "xx",
+   *   apiVersion: "xx",
+   *   extParams: {
+   *     xx: "xx",
+   *   },
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function queryAgentToken(params: {
@@ -206,6 +263,34 @@ declare namespace ty.aistream {
    * Create session
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.createSession({
+   *   bizTag: 0,
+   *   agentToken: "xx",
+   *   sessionId: "xx",
+   *   bizConfig: {
+   *     bizCode: 65537,
+   *     sendData: ["audio", "video", "text", "image", "file"],
+   *     revData: ["text", "audio", "image", "video", "file"],
+   *   },
+   *   userData: [
+   *     {
+   *       type: 1,
+   *       payloadType: 6,
+   *       value: "xx",
+   *     },
+   *   ],
+   *   userDataJson: "{}",
+   *   reuseDataChannel: false,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function createSession(params: {
@@ -294,6 +379,19 @@ declare namespace ty.aistream {
    * Close session
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.closeSession({
+   *   sessionId: "xx",
+   *   code: 200,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function closeSession(params: {
@@ -331,6 +429,18 @@ declare namespace ty.aistream {
    * Close connection, mainly for device proxy scenario, not needed when used as App identity
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.disconnect({
+   *   connectionId: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function disconnect(params: {
@@ -365,6 +475,27 @@ declare namespace ty.aistream {
    * is invoked to begin the next event.
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.sendEventStart({
+   *   sessionId: "xx",
+   *   userData: [
+   *     {
+   *       type: 1,
+   *       payloadType: 6,
+   *       value: "xx",
+   *     },
+   *   ],
+   *   userDataJson: "{}",
+   *   eventIdPrefix: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function sendEventStart(params: {
@@ -420,6 +551,28 @@ declare namespace ty.aistream {
    * Data stream transfer end event (deprecated in new version, internal implementation always callbacks success, use sendEventEnd directly after all data transfer is complete)
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.sendEventPayloadEnd({
+   *   eventId: "xx",
+   *   sessionId: "xx",
+   *   dataChannel: "audio",
+   *   userData: [
+   *     {
+   *       type: 1,
+   *       payloadType: 6,
+   *       value: "xx",
+   *     },
+   *   ],
+   *   userDataJson: "{}",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function sendEventPayloadEnd(params: {
@@ -473,6 +626,27 @@ declare namespace ty.aistream {
    * a new sendEventStart must be invoked to obtain a fresh eventId for the next event.
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.sendEventEnd({
+   *   eventId: "xx",
+   *   sessionId: "xx",
+   *   userData: [
+   *     {
+   *       type: 1,
+   *       payloadType: 6,
+   *       value: "xx",
+   *     },
+   *   ],
+   *   userDataJson: "{}",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function sendEventEnd(params: {
@@ -520,6 +694,27 @@ declare namespace ty.aistream {
    * Interrupt event. Used for: 1. abort own sending, 2. abort receiving cloud reply
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.sendEventChatBreak({
+   *   eventId: "xx",
+   *   sessionId: "xx",
+   *   userData: [
+   *     {
+   *       type: 1,
+   *       payloadType: 6,
+   *       value: "xx",
+   *     },
+   *   ],
+   *   userDataJson: "{}",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function sendEventChatBreak(params: {
@@ -567,6 +762,29 @@ declare namespace ty.aistream {
    * Send generic event (e.g. MCP response). Builds a StreamEvent with the given eventType and optional payload/userData, then sends it via the channel.
    * @public
    * @since AIStreamKit 2.2.0
+   * @example
+   * ```tsx
+   * ty.aistream.sendEvent({
+   *   sessionId: "xx",
+   *   eventId: "xx",
+   *   eventType: 1000,
+   *   payload: "xx",
+   *   userData: [
+   *     {
+   *       type: 1,
+   *       payloadType: 6,
+   *       value: "xx",
+   *     },
+   *   ],
+   *   userDataJson: "{}",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function sendEvent(params: {
@@ -636,6 +854,18 @@ declare namespace ty.aistream {
    * Currently only SampleRate can be customized
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.initAudioRecorder({
+   *   sampleRate: 16000,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function initAudioRecorder(params?: {
@@ -671,6 +901,31 @@ declare namespace ty.aistream {
    * Note: initialization takes 300 ~ 600ms, speech cannot be captured during this time, it is recommended to call `initAudioRecorder` in advance
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.startRecordAndSendAudioData({
+   *   sessionId: "xx",
+   *   dataChannel: "audio",
+   *   userData: [
+   *     {
+   *       type: 1,
+   *       payloadType: 6,
+   *       value: "xx",
+   *     },
+   *   ],
+   *   saveFile: false,
+   *   recordInitParams: {
+   *     sampleRate: 16000,
+   *   },
+   *   userDataJson: "{}",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function startRecordAndSendAudioData(params: {
@@ -732,6 +987,31 @@ declare namespace ty.aistream {
    * Stop recording and sending audio data
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.stopRecordAndSendAudioData({
+   *   sessionId: "xx",
+   *   dataChannel: "audio",
+   *   userData: [
+   *     {
+   *       type: 1,
+   *       payloadType: 6,
+   *       value: "xx",
+   *     },
+   *   ],
+   *   saveFile: false,
+   *   recordInitParams: {
+   *     sampleRate: 16000,
+   *   },
+   *   userDataJson: "{}",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function stopRecordAndSendAudioData(params: {
@@ -824,6 +1104,29 @@ declare namespace ty.aistream {
    * Send image data
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.sendImageData({
+   *   sessionId: "xx",
+   *   dataChannel: "image",
+   *   path: "xx",
+   *   format: 1,
+   *   userData: [
+   *     {
+   *       type: 1,
+   *       payloadType: 6,
+   *       value: "xx",
+   *     },
+   *   ],
+   *   userDataJson: "{}",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function sendImageData(params: {
@@ -881,6 +1184,28 @@ declare namespace ty.aistream {
    * Send text data
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.sendTextData({
+   *   sessionId: "xx",
+   *   dataChannel: "text",
+   *   text: "xx",
+   *   userData: [
+   *     {
+   *       type: 1,
+   *       payloadType: 6,
+   *       value: "xx",
+   *     },
+   *   ],
+   *   userDataJson: "{}",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function sendTextData(params: {
@@ -933,6 +1258,29 @@ declare namespace ty.aistream {
    * Batch query records
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.queryRecordList({
+   *   id: [1],
+   *   bizCode: [65537],
+   *   solutionCode: ["xx"],
+   *   devId: ["xx"],
+   *   homeId: [1],
+   *   type: ["xx"],
+   *   index: ["xx"],
+   *   index1: ["xx"],
+   *   index2: ["xx"],
+   *   offset: 0,
+   *   limit: 20,
+   *   sortType: 0,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function queryRecordList(params?: {
@@ -1033,6 +1381,26 @@ declare namespace ty.aistream {
    * Batch delete records
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.deleteRecordList({
+   *   id: [1],
+   *   bizCode: [65537],
+   *   solutionCode: ["xx"],
+   *   devId: ["xx"],
+   *   homeId: [1],
+   *   type: ["xx"],
+   *   index: ["xx"],
+   *   index1: ["xx"],
+   *   index2: ["xx"],
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function deleteRecordList(params?: {
@@ -1122,6 +1490,30 @@ declare namespace ty.aistream {
    * Update single record
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.updateRecord({
+   *   id: 1,
+   *   bizCode: 65537,
+   *   solutionCode: "xx",
+   *   devId: "xx",
+   *   homeId: 1,
+   *   type: "xx",
+   *   index: "xx",
+   *   index1: "xx",
+   *   index2: "xx",
+   *   data: "{}",
+   *   value: "xx",
+   *   value1: "xx",
+   *   value2: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function updateRecord(params?: {
@@ -1214,6 +1606,29 @@ declare namespace ty.aistream {
    * Insert single record
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.insertRecord({
+   *   bizCode: 65537,
+   *   solutionCode: "xx",
+   *   devId: "xx",
+   *   homeId: 1,
+   *   type: "xx",
+   *   index: "xx",
+   *   index1: "xx",
+   *   index2: "xx",
+   *   data: "{}",
+   *   value: "xx",
+   *   value1: "xx",
+   *   value2: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function insertRecord(params?: {
@@ -1312,6 +1727,18 @@ declare namespace ty.aistream {
    * Register audio amplitude listener (via `onRecordAmplitudes` callback)
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.registerRecordAmplitudes({
+   *   count: 1,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function registerRecordAmplitudes(params: {
@@ -1344,6 +1771,17 @@ declare namespace ty.aistream {
    * Unregister audio amplitude listener
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.unregisterVoiceAmplitudes({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function unregisterVoiceAmplitudes(params?: {
@@ -1371,6 +1809,23 @@ declare namespace ty.aistream {
    * Start playing received audio data
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.startPlayAudio({
+   *   path: "xx",
+   *   codecType: 101,
+   *   sampleRate: 16000,
+   *   channels: 1,
+   *   bitDepth: 16,
+   *   pts: 1,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function startPlayAudio(params: {
@@ -1436,6 +1891,17 @@ declare namespace ty.aistream {
    * Stop playing audio
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.stopPlayAudio({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
    * @platform iOS Android
    */
   export function stopPlayAudio(params?: {
@@ -1463,6 +1929,12 @@ declare namespace ty.aistream {
    * Listen for Event receiving reports, note the eventType difference in body.
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.onEventReceived(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onEventReceived(listener: (params: EventBody) => void): void
@@ -1471,7 +1943,7 @@ declare namespace ty.aistream {
    * Listen for Event receiving reports, note the eventType difference in body.
    * @public
    * @since AIStreamKit 1.0.0
-   * @example Demo
+   * @example
    * ```tsx
    * const listener = function (res) { console.log(res) }
    * ty.aistream.onEventReceived(listener)
@@ -1487,6 +1959,12 @@ declare namespace ty.aistream {
    * not triggered when streamFlag == 2 (transferring).
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.onAudioReceived(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onAudioReceived(listener: (params: AudioBody) => void): void
@@ -1497,7 +1975,7 @@ declare namespace ty.aistream {
    * not triggered when streamFlag == 2 (transferring).
    * @public
    * @since AIStreamKit 1.0.0
-   * @example Demo
+   * @example
    * ```tsx
    * const listener = function (res) { console.log(res) }
    * ty.aistream.onAudioReceived(listener)
@@ -1518,6 +1996,12 @@ declare namespace ty.aistream {
    * is non-empty, regardless of streamFlag.
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.onImageReceived(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onImageReceived(listener: (params: ImageBody) => void): void
@@ -1533,7 +2017,7 @@ declare namespace ty.aistream {
    * is non-empty, regardless of streamFlag.
    * @public
    * @since AIStreamKit 1.0.0
-   * @example Demo
+   * @example
    * ```tsx
    * const listener = function (res) { console.log(res) }
    * ty.aistream.onImageReceived(listener)
@@ -1547,6 +2031,12 @@ declare namespace ty.aistream {
    * Listen for text data receiving reports
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.onTextReceived(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onTextReceived(listener: (params: TextBody) => void): void
@@ -1555,7 +2045,7 @@ declare namespace ty.aistream {
    * Listen for text data receiving reports
    * @public
    * @since AIStreamKit 1.0.0
-   * @example Demo
+   * @example
    * ```tsx
    * const listener = function (res) { console.log(res) }
    * ty.aistream.onTextReceived(listener)
@@ -1569,6 +2059,12 @@ declare namespace ty.aistream {
    * Listen for channel connection state changes
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.onConnectStateChanged(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onConnectStateChanged(
@@ -1579,7 +2075,7 @@ declare namespace ty.aistream {
    * Listen for channel connection state changes
    * @public
    * @since AIStreamKit 1.0.0
-   * @example Demo
+   * @example
    * ```tsx
    * const listener = function (res) { console.log(res) }
    * ty.aistream.onConnectStateChanged(listener)
@@ -1595,6 +2091,12 @@ declare namespace ty.aistream {
    * Listen for session state changes
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.onSessionStateChanged(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onSessionStateChanged(
@@ -1605,7 +2107,7 @@ declare namespace ty.aistream {
    * Listen for session state changes
    * @public
    * @since AIStreamKit 1.0.0
-   * @example Demo
+   * @example
    * ```tsx
    * const listener = function (res) { console.log(res) }
    * ty.aistream.onSessionStateChanged(listener)
@@ -1621,6 +2123,12 @@ declare namespace ty.aistream {
    * Audio amplitude callback (register listener via `registerRecordAmplitudes` first)
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.onRecordAmplitudes(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onRecordAmplitudes(
@@ -1631,7 +2139,7 @@ declare namespace ty.aistream {
    * Audio amplitude callback (register listener via `registerRecordAmplitudes` first)
    * @public
    * @since AIStreamKit 1.0.0
-   * @example Demo
+   * @example
    * ```tsx
    * const listener = function (res) { console.log(res) }
    * ty.aistream.onRecordAmplitudes(listener)
@@ -1647,6 +2155,12 @@ declare namespace ty.aistream {
    * Audio playback state change
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.onAudioPlayChanged(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onAudioPlayChanged(
@@ -1657,7 +2171,7 @@ declare namespace ty.aistream {
    * Audio playback state change
    * @public
    * @since AIStreamKit 1.0.0
-   * @example Demo
+   * @example
    * ```tsx
    * const listener = function (res) { console.log(res) }
    * ty.aistream.onAudioPlayChanged(listener)
@@ -1673,6 +2187,12 @@ declare namespace ty.aistream {
    * Audio recording and sending error
    * @public
    * @since AIStreamKit 1.0.0
+   * @example
+   * ```tsx
+   * ty.aistream.onRecordAndSendAudioFail(e => {
+   *   console.log(e);
+   * });
+   * ```
    * @platform iOS Android
    */
   export function onRecordAndSendAudioFail(
@@ -1683,7 +2203,7 @@ declare namespace ty.aistream {
    * Audio recording and sending error
    * @public
    * @since AIStreamKit 1.0.0
-   * @example Demo
+   * @example
    * ```tsx
    * const listener = function (res) { console.log(res) }
    * ty.aistream.onRecordAndSendAudioFail(listener)