Function RoomApiAxiosParamCreator

  • RoomApiAxiosParamCreator(configuration?): {
        addComponent: ((roomId, addComponentRequest?, options?) => Promise<RequestArgs>);
        addPeer: ((roomId, addPeerRequest?, options?) => Promise<RequestArgs>);
        createRoom: ((roomConfig?, options?) => Promise<RequestArgs>);
        deleteComponent: ((roomId, id, options?) => Promise<RequestArgs>);
        deletePeer: ((roomId, id, options?) => Promise<RequestArgs>);
        deleteRoom: ((roomId, options?) => Promise<RequestArgs>);
        getAllRooms: ((options?) => Promise<RequestArgs>);
        getRoom: ((roomId, options?) => Promise<RequestArgs>);
        subscribeTo: ((roomId, componentId, subscriptionConfig?, options?) => Promise<RequestArgs>);
    }

  • RoomApi - axios parameter creator

    Parameters

    Returns {
        addComponent: ((roomId, addComponentRequest?, options?) => Promise<RequestArgs>);
        addPeer: ((roomId, addPeerRequest?, options?) => Promise<RequestArgs>);
        createRoom: ((roomConfig?, options?) => Promise<RequestArgs>);
        deleteComponent: ((roomId, id, options?) => Promise<RequestArgs>);
        deletePeer: ((roomId, id, options?) => Promise<RequestArgs>);
        deleteRoom: ((roomId, options?) => Promise<RequestArgs>);
        getAllRooms: ((options?) => Promise<RequestArgs>);
        getRoom: ((roomId, options?) => Promise<RequestArgs>);
        subscribeTo: ((roomId, componentId, subscriptionConfig?, options?) => Promise<RequestArgs>);
    }

    • addComponent: ((roomId, addComponentRequest?, options?) => Promise<RequestArgs>)

      Summary

      Creates the component and adds it to the room

      Throws

        • (roomId, addComponentRequest?, options?): Promise<RequestArgs>

        • Parameters

          • roomId: string

            Room ID

          • Optional addComponentRequest: AddComponentRequest

            Component config

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • addPeer: ((roomId, addPeerRequest?, options?) => Promise<RequestArgs>)

      Summary

      Create peer

      Throws

        • (roomId, addPeerRequest?, options?): Promise<RequestArgs>

        • Parameters

          • roomId: string

            Room id

          • Optional addPeerRequest: AddPeerRequest

            Peer specification

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • createRoom: ((roomConfig?, options?) => Promise<RequestArgs>)

      Summary

      Creates a room

      Throws

        • (roomConfig?, options?): Promise<RequestArgs>

        • Parameters

          • Optional roomConfig: RoomConfig

            Room configuration

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • deleteComponent: ((roomId, id, options?) => Promise<RequestArgs>)

      Summary

      Delete the component from the room

      Throws

        • (roomId, id, options?): Promise<RequestArgs>

        • Parameters

          • roomId: string

            Room ID

          • id: string

            Component ID

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • deletePeer: ((roomId, id, options?) => Promise<RequestArgs>)

      Summary

      Delete peer

      Throws

        • (roomId, id, options?): Promise<RequestArgs>

        • Parameters

          • roomId: string

            Room ID

          • id: string

            Peer id

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • deleteRoom: ((roomId, options?) => Promise<RequestArgs>)

      Summary

      Delete the room

      Throws

        • (roomId, options?): Promise<RequestArgs>

        • Parameters

          • roomId: string

            Room id

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getAllRooms: ((options?) => Promise<RequestArgs>)

      Summary

      Show information about all rooms

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getRoom: ((roomId, options?) => Promise<RequestArgs>)

      Summary

      Shows information about the room

      Throws

        • (roomId, options?): Promise<RequestArgs>

        • Parameters

          • roomId: string

            Room ID

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • subscribeTo: ((roomId, componentId, subscriptionConfig?, options?) => Promise<RequestArgs>)

      Summary

      Subscribe component to the tracks of peers or components

      Throws

        • (roomId, componentId, subscriptionConfig?, options?): Promise<RequestArgs>

        • Parameters

          • roomId: string

            Room ID

          • componentId: string

            Component ID

          • Optional subscriptionConfig: SubscriptionConfig

            Subscribe configuration

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    Export

Settings

Member Visibility

Theme