import {OdinRoom} from "./odin.room";

/**
 * The Odin client is the main entry point for the Odin SDK. It is used to create rooms. Create an instance with your
 * access key and use it to create rooms.
 */
export declare class OdinClient {
    /**
     * Creates a new instance of a client. Use this to create rooms.
     * @param sampleRate - The sample rate of the audio stream (between 8000 and 48000) - default is 48000
     * @param channelCount - The number of channels of the audio stream (1 or 2) - default is 1
     */
    constructor(sampleRate?: number, channelCount?: number);

    /**
     * Generates a token for the given access key, room and user ID. This token can be used to join the room.
     * To be more consistent with other SDKs, this method is deprecated. Use generateToken instead.
     * @param accessKey - The access key to use to generate the token. You can get a free access token in our developer center
     * @param roomId - The ID of the room to generate the token for.
     * @param userId - The ID of the user to generate the token for.
     * @deprecated Use generateToken instead
     */
    generateAccessToken(accessKey: string, roomId: string, userId: string): string;

    /**
     * Generates a room token for the given access key, room and user ID. This token can be used to join the room.
     * @param accessKey - The access key to use to generate the token. You can get a free access token in our developer center
     * @param roomId - The ID of the room to generate the token for.
     * @param userId - The ID of the user to generate the token for.
     */
    generateToken(accessKey: string, roomId: string, userId: string): string;

    /**
     * Creates a new local room instance with the given ID and user ID. Use join to connect to that room.
     * @param accessKey - The access key to use to generate the token. You can get a free access token in our developer center
     * @param roomId - The ID of the room to create.
     * @param userId - The ID of the user to create the room for.
     */
    createRoom(accessKey: string, roomId: string, userId: string): OdinRoom;

    /**
     * Creates a new local room instance with the given access token. Use `join` on the returned OdinRoom instance to
     * connect to that room. Use this method if you already have an access token, either created elsewhere or by calling
     * `generateToken`.
     * To be more consistent with other SDKs, this method is deprecated. Use createRoomWithToken instead.
     * @param accessToken - The access token to use to join the room.
     * @deprecated Use createRoomWithToken instead
    */
    createRoomWithAccessToken(accessToken: string): OdinRoom;

    /**
     * Creates a new local room instance with the given room token. Use `join` on the returned OdinRoom instance to
     * connect to that room. Use this method if you already have an access token, either created elsewhere or by calling
     * `generateAccessToken`.
     * @param accessToken - The access token to use to join the room.
     */
    createRoomWithToken(accessToken: string): OdinRoom;
}