Function RoomApiFp

Returns {
    addComponent(roomId, addComponentRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<ComponentDetailsResponse>)>;
    addPeer(roomId, addPeerRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<PeerDetailsResponse>)>;
    createRoom(roomConfig?, options?): Promise<((axios?, basePath?) => AxiosPromise<RoomCreateDetailsResponse>)>;
    deleteComponent(roomId, id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    deletePeer(roomId, id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    deleteRoom(roomId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    getAllRooms(options?): Promise<((axios?, basePath?) => AxiosPromise<RoomsListingResponse>)>;
    getRoom(roomId, options?): Promise<((axios?, basePath?) => AxiosPromise<RoomDetailsResponse>)>;
    subscribeTo(roomId, componentId, subscriptionConfig?, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>;
}

• addComponent:function

  • addComponent(roomId, addComponentRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<ComponentDetailsResponse>)>

  • Parameters

    • roomId: string

      Room ID
    • Optional addComponentRequest: AddComponentRequest

      Component config
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ComponentDetailsResponse>)>

    Summary

    Creates the component and adds it to the room

    Throws

• addPeer:function

  • addPeer(roomId, addPeerRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<PeerDetailsResponse>)>

  • Parameters

    • roomId: string

      Room id
    • Optional addPeerRequest: AddPeerRequest

      Peer specification
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<PeerDetailsResponse>)>

    Summary

    Create peer

    Throws

• createRoom:function

  • createRoom(roomConfig?, options?): Promise<((axios?, basePath?) => AxiosPromise<RoomCreateDetailsResponse>)>

  • Parameters

    • Optional roomConfig: RoomConfig

      Room configuration
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<RoomCreateDetailsResponse>)>

    Summary

    Creates a room

    Throws

• deleteComponent:function

  • deleteComponent(roomId, id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • roomId: string

      Room ID
    • id: string

      Component ID
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete the component from the room

    Throws

• deletePeer:function

  • deletePeer(roomId, id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • roomId: string

      Room ID
    • id: string

      Peer id
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete peer

    Throws

• deleteRoom:function

  • deleteRoom(roomId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • roomId: string

      Room id
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete the room

    Throws

• getAllRooms:function

  • getAllRooms(options?): Promise<((axios?, basePath?) => AxiosPromise<RoomsListingResponse>)>

  • Parameters

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<RoomsListingResponse>)>

    Summary

    Show information about all rooms

    Throws

• getRoom:function

  • getRoom(roomId, options?): Promise<((axios?, basePath?) => AxiosPromise<RoomDetailsResponse>)>

  • Parameters

    • roomId: string

      Room ID
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<RoomDetailsResponse>)>

    Summary

    Shows information about the room

    Throws

• subscribeTo:function

  • subscribeTo(roomId, componentId, subscriptionConfig?, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • roomId: string

      Room ID
    • componentId: string

      Component ID
    • Optional subscriptionConfig: SubscriptionConfig

      Subscribe configuration
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Subscribe component to the tracks of peers or components

    Throws