Options
All
  • Public
  • Public/Protected
  • All
Menu

@skyway-sdk/room

Index

Classes

Interfaces

Type Aliases

Variables

Type Aliases

AppAction: typeof AppActions[number]
AppScope: { actions?: readonly AppAction[]; channels?: ChannelScope[]; id: string; turn?: boolean }

Type declaration

  • Optional actions?: readonly AppAction[]

    アプリケーション自体に関する権限。現在は'read'固定

  • Optional channels?: ChannelScope[]

    channelリソースに関するオブジェクトを配列で指定

  • id: string

    アプリケーションIDを指定

  • Optional turn?: boolean

    falseの場合はTurnサーバを経由してメディア通信を行いません。

AudioMediaTrackConstraints: { autoGainControl?: ConstrainBoolean; channelCount?: ConstrainULong; deviceId?: ConstrainDOMString; echoCancellation?: ConstrainBoolean; latency?: ConstrainDouble; noiseSuppression?: ConstrainBoolean; sampleRate?: ConstrainULong; sampleSize?: ConstrainULong; suppressLocalAudioPlayback?: ConstrainBoolean; volume?: number }
description

[japanese] ブラウザによって対応しているパラメータが異なるので、必要に応じて確認してください

Type declaration

  • Optional autoGainControl?: ConstrainBoolean
  • Optional channelCount?: ConstrainULong
  • Optional deviceId?: ConstrainDOMString
  • Optional echoCancellation?: ConstrainBoolean
  • Optional latency?: ConstrainDouble
  • Optional noiseSuppression?: ConstrainBoolean
  • Optional sampleRate?: ConstrainULong
  • Optional sampleSize?: ConstrainULong
  • Optional suppressLocalAudioPlayback?: ConstrainBoolean
  • Optional volume?: number
    description

    [english] Non-standard. Check browser support before using.

AuthToken: { exp: number; iat: number; jti: string; scope: { app: AppScope } }

Type declaration

  • exp: number

    seconds

  • iat: number

    seconds

  • jti: string

    uuid

  • scope: { app: AppScope }
ChannelAction: typeof ChannelActions[number]
ChannelScope: { actions: readonly ChannelAction[]; id?: string; members: MemberScope[]; name?: string; sfuBots?: SfuScope[] }

Type declaration

  • [key: string]: unknown
  • actions: readonly ChannelAction[]

    以下を複数指定可能

    • write: すべて可能
    • read: 参照
    • create: 作成
    • delete: 削除
    • updateMetadata: metadata の編集
  • Optional id?: string
    • id または name のどちらかが必須。
    • id で対象の channel を指定。
    • '*' を指定することで、すべての channel を指定。
  • members: MemberScope[]

    member リソースに関するオブジェクトを配列で指定

  • Optional name?: string
    • id または name のどちらかが必須。
    • name で対象の channel を指定。
    • '*' を指定することで、すべての channel を指定。
  • Optional sfuBots?: SfuScope[]

    sfuBot リソースに関するオブジェクトを配列で指定

ChannelState: "opened" | "closed"
Codec: { mimeType: string; parameters?: Partial<CodecParameters>; rate?: number }

Type declaration

  • mimeType: string
  • Optional parameters?: Partial<CodecParameters>
    description

    [japanese] fmtpのパラメータを設定する

  • Optional rate?: number
CodecParameters: { usedtx: boolean | number }

Type declaration

  • [key: string]: any
  • usedtx: boolean | number
    description

    [japanese] 発話していない時の音声通信を停止する。デフォルトで有効

ContentType: "audio" | "data" | "video"
DataStreamMessageType: string | ArrayBuffer | object
DataStreamOptions: { maxPacketLifeTime?: number; maxRetransmits?: number; ordered?: boolean }

Type declaration

  • Optional maxPacketLifeTime?: number
    description

    [japanese] 再送待ち時間上限

  • Optional maxRetransmits?: number
    description

    [japanese] 再送回数上限

  • Optional ordered?: boolean
    description

    [japanese] 順序制御

DisplayStreamOptions: { audio?: AudioMediaTrackConstraints & Partial<Pick<LocalMediaStreamOptions, "stopTrackWhenDisabled">> | boolean; video?: DisplayMediaTrackConstraints & VideoMediaTrackConstraints & Partial<Pick<LocalMediaStreamOptions, "stopTrackWhenDisabled">> }

Type declaration

EncodingParameters: { id?: string; maxBitrate?: number; maxFramerate?: number; scaleResolutionDownBy?: number }

Type declaration

ForwardingAction: typeof ForwardingActions[number]
ForwardingScope: { actions: readonly ForwardingAction[]; subscription?: SfuSubscriptionScope }

Type declaration

  • actions: readonly ForwardingAction[]

    以下を複数指定可能

    • write: 作成、削除
    • create: 作成 (任意のメディアをSFU経由で新たに転送することができる)
    • delete: 削除 (SFU経由でのメディア転送を取りやめることができる)
  • Optional subscription?: SfuSubscriptionScope

    subscription リソースに関するオブジェクトを指定

ListChangedEvent: {}

Type declaration

    LocalMediaStreamOptions: { isDisplayMedia: boolean; stopTrackWhenDisabled: boolean }

    Type declaration

    • isDisplayMedia: boolean
      description

      [japanese] このStreamがDisplayの映像や音声をキャプチャしたものであれば必ずTrueを入れてください。 デフォルトで無効。

    • stopTrackWhenDisabled: boolean
      description

      [japanese] このStreamのPublicationがDisableされた時にStreamのTrackをStopします。 Publicationが再度Enableされた時にデバイスを再取得します。 (trackプロパティの中身が更新されonTrackUpdatedイベントが発火します) SkyWayStreamFactory経由でLocalMediaを作成する場合はデフォルトで有効。 mediaDevice以外から作ったStream(例えばCanvasをキャプチャするなど)であれば必ずFalseを入れてください。

    LogFormat: "object" | "string"
    LogLevel: typeof logLevelTypes[number]
    MemberAction: typeof MemberActions[number]
    MemberJoinedEvent: { member: RoomMember }

    Type declaration

    MemberKeepAliveConfig: { keepaliveIntervalGapSec: number; keepaliveIntervalSec: number }
    description

    [japanese] MemberのChannelとのKeepAliveに関する設定

    description

    [japanese] Memberはブラウザのタブを閉じるとChannelから削除される。 iOS safariのようなbeforeunloadイベントに対応していないブラウザは、 タブを閉じたあと keepaliveIntervalSec + keepaliveIntervalGapSec 秒後に Channelから削除される。

    Type declaration

    • keepaliveIntervalGapSec: number
      description

      [japanese] KeepAliveの周期を超えてChannelからMemberが削除されるまでの時間

    • keepaliveIntervalSec: number
      description

      [japanese] KeepAliveを行う周期

    MemberLeftEvent: { member: RoomMember }

    Type declaration

    MemberMetadataUpdatedEvent: { member: RoomMember; metadata: string }

    Type declaration

    MemberScope: { actions: readonly MemberAction[]; id?: string; name?: string; publication?: PublicationScope; subscription?: SubscriptionScope }

    Type declaration

    • actions: readonly MemberAction[]

      以下を複数指定可能

      • write: すべて可能
      • create: 入室(入室時に member が作成される)
      • delete: 退室(入室時に member が削除される)
      • signal: シグナリング情報のやり取り (p2p通信を利用する際に必須)
      • updateMetadata: metadata の編集
    • Optional id?: string

      id (id または name のどちらかが必須 *)

      • id で対象の member を指定
      • '*' を指定することで、すべての member を指定
    • Optional name?: string

      name (id または name のどちらかが必須 *)

      • name で対象の channel を指定
      • '*' を指定することで、すべての member を指定
    • Optional publication?: PublicationScope

      publication リソースに関するオブジェクトを指定

    • Optional subscription?: SubscriptionScope

      subscription リソースに関するオブジェクトを指定

    MemberSide: "local" | "remote"
    MemberState: "joined" | "left"
    MemberStateChangedEvent: { member: RoomMember }

    Type declaration

    MemberType: "person" | "bot"
    P2PRoomInit: RoomInitBase & { type: "p2p" }
    PersonInit: { metadata?: MemberInit["metadata"]; name?: MemberInit["name"] } & Partial<MemberKeepAliveConfig> & MemberInternalConfig
    PublicationAction: typeof PublicationActions[number]
    PublicationDisabledEvent: { publication: RoomPublication }

    Type declaration

    PublicationEnabledEvent: { publication: RoomPublication }

    Type declaration

    PublicationMetadataUpdatedEvent: { metadata: string; publication: RoomPublication }

    Type declaration

    PublicationOptions: { codecCapabilities?: Codec[]; encodings?: EncodingParameters[]; metadata?: string }

    Type declaration

    • Optional codecCapabilities?: Codec[]
      description

      [japanese] publishする際に優先して利用するCodec設定を指定する。 利用するCodecは配列の先頭が優先される。

    • Optional encodings?: EncodingParameters[]
      description

      [japanese] メディアのエンコードの設定を行うことができる。 サイマルキャストに対応している通信モデル(SFU)を利用している場合、encodingsの配列に複数のEncodingを設定するとサイマルキャストが有効になる。 そうでない場合、先頭の設定のみが適用される。 設定を複数入れる場合ビットレートの低いものが先頭になるように並べる必要がある。

    • Optional metadata?: string
    PublicationScope: { actions: readonly PublicationAction[] }

    Type declaration

    • actions: readonly PublicationAction[]

      以下を複数指定可能

      • write: すべて可能
      • create: publish(publish時に publication が作成される)
      • delete: unpublish(unpublish時に publication が削除される)
      • updateMetadata: metadata の編集
      • enable: enable
      • disable: disable
    PublicationState: "enabled" | "disabled" | "canceled"
    description

    [japanese] Publicationの状態

    • enabled : 配信中
    • disabled : 配信停止中
    • canceled : 配信終了
    PublicationStateChangedEvent: { publication: RoomPublication }

    Type declaration

    ReplaceStreamOptions: { releaseOldStream?: boolean }

    Type declaration

    • Optional releaseOldStream?: boolean
      description

      [japanese] 入れ替え前のstreamを開放する。デフォルトで有効

    RoomClosedEvent: {}

    Type declaration

      RoomInitBase: { metadata?: string; name?: string; type: RoomType }

      Type declaration

      • Optional metadata?: string
      • Optional name?: string
      • type: RoomType
      RoomMemberInit: PersonInit
      RoomMemberState: MemberState
      RoomMetadataUpdatedEvent: { metadata: string }

      Type declaration

      • metadata: string
      RoomPublicationOptions: PublicationOptions & { maxSubscribers?: number }
      RoomPublicationState: PublicationState
      description

      [japanese] Publicationの状態

      • enabled : 配信中
      • disabled : 配信停止中
      • canceled : 配信終了
      RoomState: ChannelState
      RoomSubscriptionState: SubscriptionState
      RoomType: typeof roomTypes[number]
      SfuApiOptions: { domain: string; log: { format: LogFormat; level: LogLevel }; secure: boolean; version: number }

      Type declaration

      SfuBotAction: typeof SfuBotActions[number]
      SfuBotPluginOptions: Omit<SfuApiOptions, "log"> & { ackTimeout: number; disableRestartIce: boolean; endpointTimeout: number }
      SfuRoomInit: RoomInitBase & { options?: Partial<SfuRoomOptions>; type: "sfu" }
      SfuRoomOptions: { sfu: Partial<SfuBotPluginOptions> }

      Type declaration

      SfuRoomPublicationOptions: { maxSubscribers?: number }

      Type declaration

      • Optional maxSubscribers?: number
      SfuScope: { actions: readonly SfuBotAction[]; forwardings: ForwardingScope[] }

      Type declaration

      • actions: readonly SfuBotAction[]

        以下を複数指定可能

        • write: 作成、削除
        • create: 作成
        • delete: 削除
      • forwardings: ForwardingScope[]

        forwarding リソースに関するオブジェクトを指定(forwardingオブジェクトについては後述)

      SfuSubscriptionAction: typeof SfuSubscriptionActions[number]
      SfuSubscriptionScope: { actions: readonly SfuSubscriptionAction[] }

      Type declaration

      • actions: readonly SfuSubscriptionAction[]

        以下を複数指定可能

        • write: subscribe、unsubscribe
        • create: subscribe(subscribe時に subscription が作成される)
        • delete: unsubscribe(unsubscribe時に subscription が削除される)
      SkyWayConfigOptions: { log: Partial<{ format: LogFormat; level: LogLevel }>; member: Partial<MemberKeepAliveConfig>; rtcConfig: { encodedInsertableStreams?: boolean; turnPolicy?: TurnPolicy; turnProtocol?: TurnProtocol }; token: { updateReminderSec?: number } }

      Type declaration

      StreamPublishedEvent: { publication: RoomPublication }

      Type declaration

      StreamSubscribedEvent: { subscription: RoomSubscription }

      Type declaration

      StreamUnpublishedEvent: { publication: RoomPublication }

      Type declaration

      StreamUnsubscribedEvent: { subscription: RoomSubscription }

      Type declaration

      SubscriptionAction: typeof SubscriptionActions[number]
      SubscriptionOptions: { preferredEncodingId?: string }

      Type declaration

      • Optional preferredEncodingId?: string
      SubscriptionScope: { actions: readonly SubscriptionAction[] }

      Type declaration

      • actions: readonly SubscriptionAction[]

        以下を複数指定可能

        • write: すべて可能
        • create: subscribe(subscribe時に subscription が作成される)
        • delete: unsubscribe(unsubscribe時に subscription が削除される)
      SubscriptionState: "enabled" | "canceled"
      TransportConnectionState: "new" | "connecting" | "connected" | "reconnecting" | "disconnected"
      TurnPolicy: "enable" | "disable" | "turnOnly"
      TurnProtocol: "all" | "udp" | "tcp" | "tls"
      VideoMediaTrackConstraints: { aspectRatio?: ConstrainDouble; deviceId?: ConstrainDOMString; facingMode?: ConstrainDOMString; frameRate?: ConstrainDouble; height?: ConstrainULong; width?: ConstrainULong }
      description

      [japanese] ブラウザによって対応しているパラメータが異なるので、必要に応じて確認してください

      Type declaration

      • Optional aspectRatio?: ConstrainDouble
      • Optional deviceId?: ConstrainDOMString
      • Optional facingMode?: ConstrainDOMString
      • Optional frameRate?: ConstrainDouble
      • Optional height?: ConstrainULong
      • Optional width?: ConstrainULong
      WebRTCStats: { id: string; type: string }[]

      Variables

      PACKAGE_VERSION: "1.6.1" = '1.6.1'
      SkyWayStreamFactory: StreamFactory
      errors: { alreadyChannelClosed: { detail: "ChannelがすでにCloseされています"; name: "alreadyChannelClosed"; solution: "ありません" }; alreadyLocalPersonExist: { detail: "ChannelにすでにLocalPersonが存在します。一つのChannelインスタンスにはLocalPersonが一つしかJoinできません"; name: "alreadyLocalPersonExist"; solution: "複数のLocalPersonを用意したい場合は個別にChannelインスタンスを用意してください。" }; alreadyPublishedStream: { detail: "すでにPublishしたStreamを再度Publishすることはできません You cannot re-publish a stream that has already been published"; name: "alreadyPublishedStream"; solution: "そのStreamをPublishしたPublicationをUnpublishするか、別の新しいStreamを作ってPublishしてください Unpublish the publication that published that stream, or create another new stream and publish it" }; alreadySameNameMemberExist: { detail: "Channelにすでに同じNameのMemberが存在します"; name: "alreadySameNameMemberExist"; solution: "別のNameを使用してください" }; alreadySubscribedPublication: { detail: "すでにSubscribeしたPublicationをSubscribeすることはできません"; name: "alreadySubscribedPublication"; solution: "ありません" }; backendError: { detail: ""; name: "backendError:"; solution: "" }; canNotEnableRemotePublication: { detail: "remoteのPublicationをenableすることはできません"; name: "canNotEnableRemotePublication"; solution: "対象のPublicationがLocalのものか確認してください" }; canNotUseReplaceStream: { detail: "remoteのPublicationからreplaceStreamできません"; name: "canNotUseReplaceStream"; solution: "対象のPublicationがLocalのものか確認してください" }; cantMoveSameIdChannel: { detail: "moveChannelで同じidのChannelに移動することは出来ません"; name: "cantMoveSameIdChannel"; solution: "移動先のChannelが正しいか確かめてください" }; confirmSubscriptionFailed: { detail: "Forwardingのconsume許可を出すのに失敗しました"; name: "confirmSubscriptionFailed"; solution: "ありません" }; connectRtcApiFailed: { detail: "RtcAPIへの接続に失敗しました"; name: "connectRtcApiFailed"; solution: "インターネットへの接続できているか、もしくはTokenのパラメータが正しいかを確かめてください" }; consumerNotFound: { detail: "SFUはLocalPersonがUnsubscribeしたSubscriptionを操出来ません"; name: "consumerNotFound"; solution: "操作対象のSubscriptionが正しいか確かめてください" }; correspondingEncodeNotExistForId: { detail: "指定されたIDに対応するEncode設定が存在しません"; name: "correspondingEncodeNotExistForId"; solution: "正しいEncodingIDを指定してください" }; dataStreamNotSupportEncoding: { detail: "dataStreamはEncode設定の変更に対応していません"; name: "dataStreamNotSupportEncoding"; solution: "ありません" }; dataStreamNotSupported: { detail: "dataStreamはSFUに対応していません"; name: "dataStreamNotSupported"; solution: "ありません" }; disabledDataStream: { detail: "関連するPublicationがDisableなDataStreamには書き込みできません"; name: "disabledDataStream"; solution: "関連するPublicationをEnableしてから書き込んでください" }; forwardingNotFound: { detail: "存在しないForwardingを操作しようとしています"; name: "forwardingNotFound"; solution: "対象のForwardingが正しいか確かめてください" }; insufficientPermissions: { detail: "tokenの権限が不足しています"; name: "insufficientPermissions"; solution: "tokenに必要な権限を付与してください" }; internal: { detail: ""; name: "internal"; solution: "" }; invalidArgumentValue: { detail: "引数の値が不正です"; name: "invalidArgumentValue"; solution: "正しい値を引数に渡してください" }; invalidContentType: { detail: "contentTypeが正しくありません"; name: "invalidContentType"; solution: "ContentTypeを確認してください" }; invalidElement: { detail: "渡されたHTML Elementが正しくありません"; name: "invalidElement"; solution: "要求された正しいElementを渡してください" }; invalidEncodings: { detail: "エンコード設定が設定されていません。エンコード設定切り替え機能が使えません"; name: "invalidEncodings"; solution: "エンコード設定切り替え機能を利用する場合はエンコード設定をしたPublicationをForwardingしてください" }; invalidExpireTokenValue: { detail: "tokenのExpire時刻が不正です"; name: "invalidExpireTokenValue"; solution: "正しい時刻を指定してください" }; invalidParameter: { detail: ""; name: "invalidParameter"; solution: "" }; invalidPreferredEncoding: { detail: "preferredEncodingの値が不正です。エンコード設定切り替え機能が使えません"; name: "invalidPreferredEncoding"; solution: "正しい文字列を入力してください" }; invalidRemindExpireTokenValue: { detail: "tokenのExpireをリマインドする時間の値が不正です"; name: "invalidRemindExpireTokenValue"; solution: "正しい時間を指定してください" }; invalidRequestParameter: { detail: "リクエストの値が不正です"; name: "invalidRequestParameter"; solution: "正しい値を入力してください" }; invalidTokenAppId: { detail: "tokenのappIdが正しくありません"; name: "invalidTokenAppId"; solution: "正しいappIdを含むTokenを使用してください" }; invalidTrackKind: { detail: "Streamの種類とMediaStreamTrackの種類が一致しません"; name: "invalidTrackKind"; solution: "Streamの種類と同じMediaStreamTrackを利用してください" }; localPersonNotJoinedChannel: { detail: "操作しようとしたPersonがChannelに居ないので、操作できません The person who tried to operate is not in the channel, so the operation is not possible"; name: "localPersonNotJoinedChannel"; solution: "Channelに居ないPersonを操作している可能性があるので確認してください Please check as you may be operating a person which is not in the channel" }; maxSubscriberExceededError: { detail: "forwardingのmaxSubscribersの制限を超えています。maxSubscribersの値を超えてSubscribeすることはできません"; name: "maxSubscribersExceededError"; solution: "maxSubscribersの範囲内でご利用ください" }; maxSubscribersMustNotBeZero: { detail: "maxSubscribersは1以上である必要があります"; name: "maxSubscribersMustNotBeZero"; solution: "正しい値を入力してください" }; mediaDevicesNotFound: { detail: "navigator.mediaDevicesがみつかりません"; name: "mediaDevicesNotFound"; solution: "アプリケーションをhttps,localhost,127.0.0.1のいずれかの環境で動作させてください" }; missingProperty: { detail: ""; name: "missingProperty"; solution: "" }; netWorkError: { detail: "通信環境に問題があります"; name: "netWorkError"; solution: "ネットワーク接続状況を確認してください" }; notAllowedConsumeError: { detail: "ForwardingからのConsume許可がありません"; name: "notAllowedConsumeError"; solution: "Forwardingしているmemberによる許可操作が必要です" }; notFound: { detail: "参照しようとしていたものが見つかりません"; name: "notFound"; solution: "参照しようとしたものが存在するか確かめてください" }; notImplemented: { detail: "対応していないRoomTypeです"; name: "notImplemented"; solution: "正しいRoomTypeを指定してください" }; publicationNotExist: { detail: "channelに該当するPublicationが存在しません"; name: "publicationNotExist"; solution: "publicationIdが正しいか確かめてください" }; publicationNotHasOrigin: { detail: "SfuRoomで操作するPublicationはOriginをもつ必要があります"; name: "publicationNotHasOrigin"; solution: "SfuRoomとP2PRoomを同一のIDで混在させていないか確かめてください" }; quotaExceededError: { detail: "リソースの制限量を超えてリソースを利用することはできません"; name: "quotaExceededError"; solution: "リソース制限量の範囲内でご利用ください" }; receiverNotFound: { detail: "SFUはRemoteMemberのSubscriptionを操作できません"; name: "receiverNotFound"; solution: "SFUでsubscriptionの操作をする際にはLocalPersonがSubscribeしているSubscriptionインスタンスを利用してください" }; remotePublisherId: { detail: "publisherがremoteのPublicationをForwardingすることはできません"; name: "remotePublisherId"; solution: "PublicationがLocalでPublishされたものか確かめてください" }; roomNotOpened: { detail: "RoomがOpenされていません"; name: "roomNotOpened"; solution: "Roomの状態を確かめてください" }; rtcApiFatalError: { detail: "RtcAPIの回復不能なエラーです。サーバー側の問題の可能性があります"; name: "rtcApiFatalError"; solution: "インターネットへの接続が出来ているかを確かめてください" }; sfuBotNotInChannel: { detail: "SfuBotがChannelに存在しません"; name: "sfuBotNotInChannel"; solution: "操作しようとしているSfuBotが正しいか確かめてください" }; sfuRoomNotSupportDataStream: { detail: "SFURoomでDataStreamを使うことは出来ません"; name: "sfuRoomNotSupportDataStream"; solution: "ありません" }; streamNotExistInPublication: { detail: "PublicationにStreamがありません。RemoteMemberのPublicationのStreamにはアクセスできません"; name: "streamNotExistInPublication"; solution: "参照しているPublicationが目的のものか確かめてください。" }; streamNotExistInSubscription: { detail: "SubscriptionにStreamがありません。RemoteMemberのSubscriptionのStreamにはアクセスできません"; name: "streamNotExistInSubscription"; solution: "参照しているSubscriptionが目的のものか確かめてください。" }; subscribeOtherMemberType: { detail: "RemoteMemberにSubscribe/Unsubscribeさせる場合、対象のMemberのTypeはPersonである必要があります"; name: "subscribeOtherMemberType"; solution: "対象のRemoteMemberが正しいか確認してください" }; subscriptionNotExist: { detail: "channelに該当するSubscriptionが存在しません"; name: "subscriptionNotExist"; solution: "subscriptionIdが正しいか確かめてください" }; timeout: { detail: ""; name: "timeout"; solution: "" }; unknownMemberType: { detail: "対象のMemberのSubtypeのプラグインが登録されていません"; name: "unknownMemberType"; solution: "対象のMemberのSubtypeのプラグイン(SfuBotなど)をSkyWayContextに登録してください" }; updateIceParamsFailed: { detail: "iceParamsの更新に失敗しました"; name: "updateIceParamsFailed"; solution: "ありません" } } = ...

      Type declaration

      • Readonly alreadyChannelClosed: { detail: "ChannelがすでにCloseされています"; name: "alreadyChannelClosed"; solution: "ありません" }
        • Readonly detail: "ChannelがすでにCloseされています"
        • Readonly name: "alreadyChannelClosed"
        • Readonly solution: "ありません"
      • Readonly alreadyLocalPersonExist: { detail: "ChannelにすでにLocalPersonが存在します。一つのChannelインスタンスにはLocalPersonが一つしかJoinできません"; name: "alreadyLocalPersonExist"; solution: "複数のLocalPersonを用意したい場合は個別にChannelインスタンスを用意してください。" }
        • Readonly detail: "ChannelにすでにLocalPersonが存在します。一つのChannelインスタンスにはLocalPersonが一つしかJoinできません"
        • Readonly name: "alreadyLocalPersonExist"
        • Readonly solution: "複数のLocalPersonを用意したい場合は個別にChannelインスタンスを用意してください。"
      • Readonly alreadyPublishedStream: { detail: "すでにPublishしたStreamを再度Publishすることはできません You cannot re-publish a stream that has already been published"; name: "alreadyPublishedStream"; solution: "そのStreamをPublishしたPublicationをUnpublishするか、別の新しいStreamを作ってPublishしてください Unpublish the publication that published that stream, or create another new stream and publish it" }
        • Readonly detail: "すでにPublishしたStreamを再度Publishすることはできません You cannot re-publish a stream that has already been published"
        • Readonly name: "alreadyPublishedStream"
        • Readonly solution: "そのStreamをPublishしたPublicationをUnpublishするか、別の新しいStreamを作ってPublishしてください Unpublish the publication that published that stream, or create another new stream and publish it"
      • Readonly alreadySameNameMemberExist: { detail: "Channelにすでに同じNameのMemberが存在します"; name: "alreadySameNameMemberExist"; solution: "別のNameを使用してください" }
        • Readonly detail: "Channelにすでに同じNameのMemberが存在します"
        • Readonly name: "alreadySameNameMemberExist"
        • Readonly solution: "別のNameを使用してください"
      • Readonly alreadySubscribedPublication: { detail: "すでにSubscribeしたPublicationをSubscribeすることはできません"; name: "alreadySubscribedPublication"; solution: "ありません" }
        • Readonly detail: "すでにSubscribeしたPublicationをSubscribeすることはできません"
        • Readonly name: "alreadySubscribedPublication"
        • Readonly solution: "ありません"
      • Readonly backendError: { detail: ""; name: "backendError:"; solution: "" }
        • Readonly detail: ""
        • Readonly name: "backendError:"
        • Readonly solution: ""
      • Readonly canNotEnableRemotePublication: { detail: "remoteのPublicationをenableすることはできません"; name: "canNotEnableRemotePublication"; solution: "対象のPublicationがLocalのものか確認してください" }
        • Readonly detail: "remoteのPublicationをenableすることはできません"
        • Readonly name: "canNotEnableRemotePublication"
        • Readonly solution: "対象のPublicationがLocalのものか確認してください"
      • Readonly canNotUseReplaceStream: { detail: "remoteのPublicationからreplaceStreamできません"; name: "canNotUseReplaceStream"; solution: "対象のPublicationがLocalのものか確認してください" }
        • Readonly detail: "remoteのPublicationからreplaceStreamできません"
        • Readonly name: "canNotUseReplaceStream"
        • Readonly solution: "対象のPublicationがLocalのものか確認してください"
      • Readonly cantMoveSameIdChannel: { detail: "moveChannelで同じidのChannelに移動することは出来ません"; name: "cantMoveSameIdChannel"; solution: "移動先のChannelが正しいか確かめてください" }
        • Readonly detail: "moveChannelで同じidのChannelに移動することは出来ません"
        • Readonly name: "cantMoveSameIdChannel"
        • Readonly solution: "移動先のChannelが正しいか確かめてください"
      • Readonly confirmSubscriptionFailed: { detail: "Forwardingのconsume許可を出すのに失敗しました"; name: "confirmSubscriptionFailed"; solution: "ありません" }
        • Readonly detail: "Forwardingのconsume許可を出すのに失敗しました"
        • Readonly name: "confirmSubscriptionFailed"
        • Readonly solution: "ありません"
      • Readonly connectRtcApiFailed: { detail: "RtcAPIへの接続に失敗しました"; name: "connectRtcApiFailed"; solution: "インターネットへの接続できているか、もしくはTokenのパラメータが正しいかを確かめてください" }
        • Readonly detail: "RtcAPIへの接続に失敗しました"
        • Readonly name: "connectRtcApiFailed"
        • Readonly solution: "インターネットへの接続できているか、もしくはTokenのパラメータが正しいかを確かめてください"
      • Readonly consumerNotFound: { detail: "SFUはLocalPersonがUnsubscribeしたSubscriptionを操出来ません"; name: "consumerNotFound"; solution: "操作対象のSubscriptionが正しいか確かめてください" }
        • Readonly detail: "SFUはLocalPersonがUnsubscribeしたSubscriptionを操出来ません"
        • Readonly name: "consumerNotFound"
        • Readonly solution: "操作対象のSubscriptionが正しいか確かめてください"
      • Readonly correspondingEncodeNotExistForId: { detail: "指定されたIDに対応するEncode設定が存在しません"; name: "correspondingEncodeNotExistForId"; solution: "正しいEncodingIDを指定してください" }
        • Readonly detail: "指定されたIDに対応するEncode設定が存在しません"
        • Readonly name: "correspondingEncodeNotExistForId"
        • Readonly solution: "正しいEncodingIDを指定してください"
      • Readonly dataStreamNotSupportEncoding: { detail: "dataStreamはEncode設定の変更に対応していません"; name: "dataStreamNotSupportEncoding"; solution: "ありません" }
        • Readonly detail: "dataStreamはEncode設定の変更に対応していません"
        • Readonly name: "dataStreamNotSupportEncoding"
        • Readonly solution: "ありません"
      • Readonly dataStreamNotSupported: { detail: "dataStreamはSFUに対応していません"; name: "dataStreamNotSupported"; solution: "ありません" }
        • Readonly detail: "dataStreamはSFUに対応していません"
        • Readonly name: "dataStreamNotSupported"
        • Readonly solution: "ありません"
      • Readonly disabledDataStream: { detail: "関連するPublicationがDisableなDataStreamには書き込みできません"; name: "disabledDataStream"; solution: "関連するPublicationをEnableしてから書き込んでください" }
        • Readonly detail: "関連するPublicationがDisableなDataStreamには書き込みできません"
        • Readonly name: "disabledDataStream"
        • Readonly solution: "関連するPublicationをEnableしてから書き込んでください"
      • Readonly forwardingNotFound: { detail: "存在しないForwardingを操作しようとしています"; name: "forwardingNotFound"; solution: "対象のForwardingが正しいか確かめてください" }
        • Readonly detail: "存在しないForwardingを操作しようとしています"
        • Readonly name: "forwardingNotFound"
        • Readonly solution: "対象のForwardingが正しいか確かめてください"
      • Readonly insufficientPermissions: { detail: "tokenの権限が不足しています"; name: "insufficientPermissions"; solution: "tokenに必要な権限を付与してください" }
        • Readonly detail: "tokenの権限が不足しています"
        • Readonly name: "insufficientPermissions"
        • Readonly solution: "tokenに必要な権限を付与してください"
      • internal: { detail: ""; name: "internal"; solution: "" }
        • detail: ""
        • name: "internal"
        • solution: ""
      • Readonly invalidArgumentValue: { detail: "引数の値が不正です"; name: "invalidArgumentValue"; solution: "正しい値を引数に渡してください" }
        • Readonly detail: "引数の値が不正です"
        • Readonly name: "invalidArgumentValue"
        • Readonly solution: "正しい値を引数に渡してください"
      • Readonly invalidContentType: { detail: "contentTypeが正しくありません"; name: "invalidContentType"; solution: "ContentTypeを確認してください" }
        • Readonly detail: "contentTypeが正しくありません"
        • Readonly name: "invalidContentType"
        • Readonly solution: "ContentTypeを確認してください"
      • Readonly invalidElement: { detail: "渡されたHTML Elementが正しくありません"; name: "invalidElement"; solution: "要求された正しいElementを渡してください" }
        • Readonly detail: "渡されたHTML Elementが正しくありません"
        • Readonly name: "invalidElement"
        • Readonly solution: "要求された正しいElementを渡してください"
      • Readonly invalidEncodings: { detail: "エンコード設定が設定されていません。エンコード設定切り替え機能が使えません"; name: "invalidEncodings"; solution: "エンコード設定切り替え機能を利用する場合はエンコード設定をしたPublicationをForwardingしてください" }
        • Readonly detail: "エンコード設定が設定されていません。エンコード設定切り替え機能が使えません"
        • Readonly name: "invalidEncodings"
        • Readonly solution: "エンコード設定切り替え機能を利用する場合はエンコード設定をしたPublicationをForwardingしてください"
      • Readonly invalidExpireTokenValue: { detail: "tokenのExpire時刻が不正です"; name: "invalidExpireTokenValue"; solution: "正しい時刻を指定してください" }
        • Readonly detail: "tokenのExpire時刻が不正です"
        • Readonly name: "invalidExpireTokenValue"
        • Readonly solution: "正しい時刻を指定してください"
      • invalidParameter: { detail: ""; name: "invalidParameter"; solution: "" }
        • detail: ""
        • name: "invalidParameter"
        • solution: ""
      • Readonly invalidPreferredEncoding: { detail: "preferredEncodingの値が不正です。エンコード設定切り替え機能が使えません"; name: "invalidPreferredEncoding"; solution: "正しい文字列を入力してください" }
        • Readonly detail: "preferredEncodingの値が不正です。エンコード設定切り替え機能が使えません"
        • Readonly name: "invalidPreferredEncoding"
        • Readonly solution: "正しい文字列を入力してください"
      • Readonly invalidRemindExpireTokenValue: { detail: "tokenのExpireをリマインドする時間の値が不正です"; name: "invalidRemindExpireTokenValue"; solution: "正しい時間を指定してください" }
        • Readonly detail: "tokenのExpireをリマインドする時間の値が不正です"
        • Readonly name: "invalidRemindExpireTokenValue"
        • Readonly solution: "正しい時間を指定してください"
      • Readonly invalidRequestParameter: { detail: "リクエストの値が不正です"; name: "invalidRequestParameter"; solution: "正しい値を入力してください" }
        • Readonly detail: "リクエストの値が不正です"
        • Readonly name: "invalidRequestParameter"
        • Readonly solution: "正しい値を入力してください"
      • Readonly invalidTokenAppId: { detail: "tokenのappIdが正しくありません"; name: "invalidTokenAppId"; solution: "正しいappIdを含むTokenを使用してください" }
        • Readonly detail: "tokenのappIdが正しくありません"
        • Readonly name: "invalidTokenAppId"
        • Readonly solution: "正しいappIdを含むTokenを使用してください"
      • Readonly invalidTrackKind: { detail: "Streamの種類とMediaStreamTrackの種類が一致しません"; name: "invalidTrackKind"; solution: "Streamの種類と同じMediaStreamTrackを利用してください" }
        • Readonly detail: "Streamの種類とMediaStreamTrackの種類が一致しません"
        • Readonly name: "invalidTrackKind"
        • Readonly solution: "Streamの種類と同じMediaStreamTrackを利用してください"
      • Readonly localPersonNotJoinedChannel: { detail: "操作しようとしたPersonがChannelに居ないので、操作できません The person who tried to operate is not in the channel, so the operation is not possible"; name: "localPersonNotJoinedChannel"; solution: "Channelに居ないPersonを操作している可能性があるので確認してください Please check as you may be operating a person which is not in the channel" }
        • Readonly detail: "操作しようとしたPersonがChannelに居ないので、操作できません The person who tried to operate is not in the channel, so the operation is not possible"
        • Readonly name: "localPersonNotJoinedChannel"
        • Readonly solution: "Channelに居ないPersonを操作している可能性があるので確認してください Please check as you may be operating a person which is not in the channel"
      • Readonly maxSubscriberExceededError: { detail: "forwardingのmaxSubscribersの制限を超えています。maxSubscribersの値を超えてSubscribeすることはできません"; name: "maxSubscribersExceededError"; solution: "maxSubscribersの範囲内でご利用ください" }
        • Readonly detail: "forwardingのmaxSubscribersの制限を超えています。maxSubscribersの値を超えてSubscribeすることはできません"
        • Readonly name: "maxSubscribersExceededError"
        • Readonly solution: "maxSubscribersの範囲内でご利用ください"
      • Readonly maxSubscribersMustNotBeZero: { detail: "maxSubscribersは1以上である必要があります"; name: "maxSubscribersMustNotBeZero"; solution: "正しい値を入力してください" }
        • Readonly detail: "maxSubscribersは1以上である必要があります"
        • Readonly name: "maxSubscribersMustNotBeZero"
        • Readonly solution: "正しい値を入力してください"
      • Readonly mediaDevicesNotFound: { detail: "navigator.mediaDevicesがみつかりません"; name: "mediaDevicesNotFound"; solution: "アプリケーションをhttps,localhost,127.0.0.1のいずれかの環境で動作させてください" }
        • Readonly detail: "navigator.mediaDevicesがみつかりません"
        • Readonly name: "mediaDevicesNotFound"
        • Readonly solution: "アプリケーションをhttps,localhost,127.0.0.1のいずれかの環境で動作させてください"
      • Readonly missingProperty: { detail: ""; name: "missingProperty"; solution: "" }
        • Readonly detail: ""
        • Readonly name: "missingProperty"
        • Readonly solution: ""
      • Readonly netWorkError: { detail: "通信環境に問題があります"; name: "netWorkError"; solution: "ネットワーク接続状況を確認してください" }
        • Readonly detail: "通信環境に問題があります"
        • Readonly name: "netWorkError"
        • Readonly solution: "ネットワーク接続状況を確認してください"
      • Readonly notAllowedConsumeError: { detail: "ForwardingからのConsume許可がありません"; name: "notAllowedConsumeError"; solution: "Forwardingしているmemberによる許可操作が必要です" }
        • Readonly detail: "ForwardingからのConsume許可がありません"
        • Readonly name: "notAllowedConsumeError"
        • Readonly solution: "Forwardingしているmemberによる許可操作が必要です"
      • notFound: { detail: "参照しようとしていたものが見つかりません"; name: "notFound"; solution: "参照しようとしたものが存在するか確かめてください" }
        • detail: "参照しようとしていたものが見つかりません"
        • name: "notFound"
        • solution: "参照しようとしたものが存在するか確かめてください"
      • notImplemented: { detail: "対応していないRoomTypeです"; name: "notImplemented"; solution: "正しいRoomTypeを指定してください" }
        • detail: "対応していないRoomTypeです"
        • name: "notImplemented"
        • solution: "正しいRoomTypeを指定してください"
      • Readonly publicationNotExist: { detail: "channelに該当するPublicationが存在しません"; name: "publicationNotExist"; solution: "publicationIdが正しいか確かめてください" }
        • Readonly detail: "channelに該当するPublicationが存在しません"
        • Readonly name: "publicationNotExist"
        • Readonly solution: "publicationIdが正しいか確かめてください"
      • publicationNotHasOrigin: { detail: "SfuRoomで操作するPublicationはOriginをもつ必要があります"; name: "publicationNotHasOrigin"; solution: "SfuRoomとP2PRoomを同一のIDで混在させていないか確かめてください" }
        • detail: "SfuRoomで操作するPublicationはOriginをもつ必要があります"
        • name: "publicationNotHasOrigin"
        • solution: "SfuRoomとP2PRoomを同一のIDで混在させていないか確かめてください"
      • Readonly quotaExceededError: { detail: "リソースの制限量を超えてリソースを利用することはできません"; name: "quotaExceededError"; solution: "リソース制限量の範囲内でご利用ください" }
        • Readonly detail: "リソースの制限量を超えてリソースを利用することはできません"
        • Readonly name: "quotaExceededError"
        • Readonly solution: "リソース制限量の範囲内でご利用ください"
      • Readonly receiverNotFound: { detail: "SFUはRemoteMemberのSubscriptionを操作できません"; name: "receiverNotFound"; solution: "SFUでsubscriptionの操作をする際にはLocalPersonがSubscribeしているSubscriptionインスタンスを利用してください" }
        • Readonly detail: "SFUはRemoteMemberのSubscriptionを操作できません"
        • Readonly name: "receiverNotFound"
        • Readonly solution: "SFUでsubscriptionの操作をする際にはLocalPersonがSubscribeしているSubscriptionインスタンスを利用してください"
      • Readonly remotePublisherId: { detail: "publisherがremoteのPublicationをForwardingすることはできません"; name: "remotePublisherId"; solution: "PublicationがLocalでPublishされたものか確かめてください" }
        • Readonly detail: "publisherがremoteのPublicationをForwardingすることはできません"
        • Readonly name: "remotePublisherId"
        • Readonly solution: "PublicationがLocalでPublishされたものか確かめてください"
      • roomNotOpened: { detail: "RoomがOpenされていません"; name: "roomNotOpened"; solution: "Roomの状態を確かめてください" }
        • detail: "RoomがOpenされていません"
        • name: "roomNotOpened"
        • solution: "Roomの状態を確かめてください"
      • Readonly rtcApiFatalError: { detail: "RtcAPIの回復不能なエラーです。サーバー側の問題の可能性があります"; name: "rtcApiFatalError"; solution: "インターネットへの接続が出来ているかを確かめてください" }
        • Readonly detail: "RtcAPIの回復不能なエラーです。サーバー側の問題の可能性があります"
        • Readonly name: "rtcApiFatalError"
        • Readonly solution: "インターネットへの接続が出来ているかを確かめてください"
      • Readonly sfuBotNotInChannel: { detail: "SfuBotがChannelに存在しません"; name: "sfuBotNotInChannel"; solution: "操作しようとしているSfuBotが正しいか確かめてください" }
        • Readonly detail: "SfuBotがChannelに存在しません"
        • Readonly name: "sfuBotNotInChannel"
        • Readonly solution: "操作しようとしているSfuBotが正しいか確かめてください"
      • sfuRoomNotSupportDataStream: { detail: "SFURoomでDataStreamを使うことは出来ません"; name: "sfuRoomNotSupportDataStream"; solution: "ありません" }
        • detail: "SFURoomでDataStreamを使うことは出来ません"
        • name: "sfuRoomNotSupportDataStream"
        • solution: "ありません"
      • Readonly streamNotExistInPublication: { detail: "PublicationにStreamがありません。RemoteMemberのPublicationのStreamにはアクセスできません"; name: "streamNotExistInPublication"; solution: "参照しているPublicationが目的のものか確かめてください。" }
        • Readonly detail: "PublicationにStreamがありません。RemoteMemberのPublicationのStreamにはアクセスできません"
        • Readonly name: "streamNotExistInPublication"
        • Readonly solution: "参照しているPublicationが目的のものか確かめてください。"
      • Readonly streamNotExistInSubscription: { detail: "SubscriptionにStreamがありません。RemoteMemberのSubscriptionのStreamにはアクセスできません"; name: "streamNotExistInSubscription"; solution: "参照しているSubscriptionが目的のものか確かめてください。" }
        • Readonly detail: "SubscriptionにStreamがありません。RemoteMemberのSubscriptionのStreamにはアクセスできません"
        • Readonly name: "streamNotExistInSubscription"
        • Readonly solution: "参照しているSubscriptionが目的のものか確かめてください。"
      • subscribeOtherMemberType: { detail: "RemoteMemberにSubscribe/Unsubscribeさせる場合、対象のMemberのTypeはPersonである必要があります"; name: "subscribeOtherMemberType"; solution: "対象のRemoteMemberが正しいか確認してください" }
        • detail: "RemoteMemberにSubscribe/Unsubscribeさせる場合、対象のMemberのTypeはPersonである必要があります"
        • name: "subscribeOtherMemberType"
        • solution: "対象のRemoteMemberが正しいか確認してください"
      • Readonly subscriptionNotExist: { detail: "channelに該当するSubscriptionが存在しません"; name: "subscriptionNotExist"; solution: "subscriptionIdが正しいか確かめてください" }
        • Readonly detail: "channelに該当するSubscriptionが存在しません"
        • Readonly name: "subscriptionNotExist"
        • Readonly solution: "subscriptionIdが正しいか確かめてください"
      • timeout: { detail: ""; name: "timeout"; solution: "" }
        • detail: ""
        • name: "timeout"
        • solution: ""
      • Readonly unknownMemberType: { detail: "対象のMemberのSubtypeのプラグインが登録されていません"; name: "unknownMemberType"; solution: "対象のMemberのSubtypeのプラグイン(SfuBotなど)をSkyWayContextに登録してください" }
        • Readonly detail: "対象のMemberのSubtypeのプラグインが登録されていません"
        • Readonly name: "unknownMemberType"
        • Readonly solution: "対象のMemberのSubtypeのプラグイン(SfuBotなど)をSkyWayContextに登録してください"
      • Readonly updateIceParamsFailed: { detail: "iceParamsの更新に失敗しました"; name: "updateIceParamsFailed"; solution: "ありません" }
        • Readonly detail: "iceParamsの更新に失敗しました"
        • Readonly name: "updateIceParamsFailed"
        • Readonly solution: "ありません"
      logLevelTypes: readonly ["disable", "error", "warn", "info", "debug"]
      description

      [japanese] 以下のいずれかを指定可能

      • disable: ログの出力を無効化する。
      • error: 回復不能なエラーに関する情報を出力する。
      • warn: SDK 内部で発生した、一時的なエラーに関する情報を出力する。基本的には SDK が内部でリトライ処理を行うことで回復する。
      • info: SDK が提供しているメソッドの呼び出しに関する情報を出力する。
      • debug: SDK の内部のメソッド呼び出しや、リクエスト・レスポンスに関する情報など、最も詳細なログを出力する。
      roomTypes: readonly ["sfu", "p2p"] = ...
      tokenErrors: { invalidParameter: { detail: "failed to decode token"; name: "invalidParameter"; solution: "Use the correct token according to the specification" } }

      Type declaration

      • Readonly invalidParameter: { detail: "failed to decode token"; name: "invalidParameter"; solution: "Use the correct token according to the specification" }
        • Readonly detail: "failed to decode token"
        • Readonly name: "invalidParameter"
        • Readonly solution: "Use the correct token according to the specification"

      Generated using TypeDoc