cloudapi/dist/states/api-states.d.ts

CLOUD API

/**
 * @interface ToClientMessageTypeType
 * @param {number} QualityControlOwnership
 * @param {number} Response
 * @param {number} focusKeyboard
 * @param {number} LargeDataStart
 * @param {number} LargeData
 * @param {number} LargeDataEnd
 */
interface ToClientMessageTypeType {
    QualityControlOwnership: number;
    Response: number;
    focusKeyboard: number;
    LargeDataStart: number;
    LargeData: number;
    LargeDataEnd: number;
    WarningAndError: number;
}
type ToCirrusClientMessageTypeType = Pick<ToClientMessageTypeType, 'LargeDataStart' | 'LargeData' | 'LargeDataEnd'>;
/**
 * @interface MessageTypeType
 * @param {number} IFrameRequest
 * @param {number} RequestQualityControl
 * @param {number} MaxFpsRequest
 * @param {number} AverageBitrateRequest
 * @param {number} StartStreaming
 * @param {number} StopStreaming
 * @param {number} RendererSetting
 * @param {number} UIInteraction
 * @param {number} Command
 * @param {number} KeyDown
 * @param {number} KeyUp
 * @param {number} KeyPress
 * @param {number} compositionend
 * @param {number} KeyDownInEditableText
 * @param {number} KeyUpInEditableText
 * @param {number} MouseEnter
 * @param {number} MouseLeave
 * @param {number} MouseDown
 * @param {number} MouseUp
 * @param {number} MouseMove
 * @param {number} MouseWheel
 * @param {number} TouchStart
 * @param {number} TouchEnd
 * @param {number} TouchMove
 * @param {number} LargeDataStart
 * @param {number} LargeData
 * @param {number} LargeDataEnd
 */
interface MessageTypeType {
    IFrameRequest: number;
    RequestQualityControl: number;
    MaxFpsRequest: number;
    AverageBitrateRequest: number;
    StartStreaming: number;
    StopStreaming: number;
    RendererSetting: number;
    UIInteraction: number;
    Command: number;
    KeyDown: number;
    KeyUp: number;
    KeyPress: number;
    compositionend: number;
    KeyDownInEditableText: number;
    KeyUpInEditableText: number;
    MouseEnter: number;
    MouseLeave: number;
    MouseDown: number;
    MouseUp: number;
    MouseMove: number;
    MouseWheel: number;
    TouchStart: number;
    TouchEnd: number;
    TouchMove: number;
    LargeDataStart: number;
    LargeData: number;
    LargeDataEnd: number;
}
type CirrusMessageTypeType = Pick<MessageTypeType, 'LargeDataStart' | 'LargeData' | 'LargeDataEnd'>;
/**
 * @interface ControlSchemeTypeType
 * @param {number} LockedMouse
 * @param {number} HoveringMouse
 */
interface ControlSchemeTypeType {
    LockedMouse: number;
    HoveringMouse: number;
}
/**
 * @interface inputOptionsType
 * @param {number} controlScheme
 * @param {boolean} fakeMouseWithTouches
 */
interface inputOptionsType {
    controlScheme: number;
    fakeMouseWithTouches: boolean;
}
/**
 * @interface MouseButtonType
 * @param {number} MainButton
 * @param {number} AuxiliaryButton
 * @param {number} SecondaryButton
 */
interface MouseButtonType {
    MainButton: number;
    AuxiliaryButton: number;
    SecondaryButton: number;
}
/**
 * @interface MouseButtonsMaskType
 * @param {number} PrimaryButton
 * @param {number} SecondaryButton
 * @param {number} AuxiliaryButton
 */
interface MouseButtonsMaskType {
    PrimaryButton: number;
    SecondaryButton: number;
    AuxiliaryButton: number;
}
/**
 * @interface apiStateType
 * @param {ToClientMessageTypeType} ToClientMessageType
 * @param {ToCirrusClientMessageTypeType} ToCirrusClientMessageType
 * @param {MessageTypeType} MessageType
 * @param {ControlSchemeTypeType} ControlSchemeType
 * @param {inputOptionsType} inputOptions
 * @param {MouseButtonType} MouseButton
 * @param {MouseButtonsMaskType} MouseButtonsMask
 */
interface apiStateType {
    ToClientMessageType: ToClientMessageTypeType;
    ToCirrusClientMessageType: ToCirrusClientMessageTypeType;
    MessageType: MessageTypeType;
    CirrusMessageType: CirrusMessageTypeType;
    ControlSchemeType: ControlSchemeTypeType;
    inputOptions: inputOptionsType;
    MouseButton: MouseButtonType;
    MouseButtonsMask: MouseButtonsMaskType;
    inputActionKey: Array<{
        keyCode: number;
        code: string;
    }>;
}
/**
 * @function useApiState
 * @returns {apiStateType}
 */
export declare const useApiState: () => apiStateType;
export {};