Options
All
  • Public
  • Public/Protected
  • All
Menu

@open-ayame/ayame-web-sdk

Index

Variables

Functions

Variables

defaultOptions

defaultOptions: ConnectionOptions = ...

Ayame Connection のデフォルトのオプションです。

audio: { direction: 'sendrecv', enabled: true}

video: { direction: 'sendrecv', enabled: true}

iceServers: []

clientId: randomString(17)

Functions

connection

  • connection(signalingUrl: string, roomId: string, options?: ConnectionOptions, debug?: boolean, isRelay?: boolean): Connection
  • desc

    Ayame Connection を生成します。

    Parameters

    • signalingUrl: string

      シグナリングに用いる websocket url

    • roomId: string

      接続する roomId

    • options: ConnectionOptions = defaultOptions
    • debug: boolean = false
    • isRelay: boolean = false

    Returns Connection

    生成された Ayame Connection

version

  • version(): string
  • desc

    Ayame Web SDK のバージョンを出力します。

    Returns string

    Ayame Web SDK のバージョン

Generated using TypeDoc