@lusor/sdk 0.0.0-stage → 1.0.0

package/dist/api/resources/sessions/resources/liveView/client/Client.d.ts

@@ -0,0 +1,210 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.js";
+import * as core from "../../../../../../core/index.js";
+import * as Lusor from "../../../../../index.js";
+export declare namespace LiveViewClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class LiveViewClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<LiveViewClient.Options>;
+    constructor(options?: LiveViewClient.Options);
+    /**
+     * Asks the phone to start a WebRTC stream for this session. Open
+     * `GET /v1/sessions/{id}/stream/events` first to receive the phone's
+     * offer. TURN servers are added automatically unless you pass
+     * `iceServers`.
+     *
+     * API keys get live view only on the customer's own phone; on a Lusor
+     * Phone every `/stream/*` route returns `403
+     * live_view_not_available_for_api_keys`.
+     *
+     * **Retries:** safe without an `Idempotency-Key`: short-lived live-view connection control that changes nothing on the phone.
+     *
+     * @param {Lusor.sessions.StartLiveViewRequest} request
+     * @param {LiveViewClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.ForbiddenError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.ConflictError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.liveView.start({
+     *         id: "id",
+     *         body: {}
+     *     })
+     */
+    start(request: Lusor.sessions.StartLiveViewRequest, requestOptions?: LiveViewClient.RequestOptions): core.HttpResponsePromise<Lusor.StreamCommandResult>;
+    private __start;
+    /**
+     * Reconnects the WebRTC stream without starting over: the phone reuses
+     * its running screen capture when it can. Same body and response as
+     * `POST /v1/sessions/{id}/stream/start`.
+     *
+     * **Retries:** safe without an `Idempotency-Key`: short-lived live-view connection control that changes nothing on the phone.
+     *
+     * @param {Lusor.sessions.ConnectLiveViewRequest} request
+     * @param {LiveViewClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.ForbiddenError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.ConflictError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.liveView.connect({
+     *         id: "id",
+     *         body: {}
+     *     })
+     */
+    connect(request: Lusor.sessions.ConnectLiveViewRequest, requestOptions?: LiveViewClient.RequestOptions): core.HttpResponsePromise<Lusor.StreamCommandResult>;
+    private __connect;
+    /**
+     * Sends one extra keep-alive to the phone. The server already sends
+     * one every 25 seconds while a stream is active, so this is optional.
+     *
+     * **Retries:** safe without an `Idempotency-Key`: short-lived live-view connection control that changes nothing on the phone.
+     *
+     * @param {Lusor.sessions.KeepaliveLiveViewRequest} request
+     * @param {LiveViewClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.ForbiddenError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.ConflictError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.liveView.keepalive({
+     *         id: "id",
+     *         body: {}
+     *     })
+     */
+    keepalive(request: Lusor.sessions.KeepaliveLiveViewRequest, requestOptions?: LiveViewClient.RequestOptions): core.HttpResponsePromise<Lusor.StreamCommandResult>;
+    private __keepalive;
+    /**
+     * Makes the phone's encoder send a keyframe, which recovers a frozen
+     * picture without reconnecting.
+     *
+     * **Retries:** safe without an `Idempotency-Key`: short-lived live-view connection control that changes nothing on the phone.
+     *
+     * @param {Lusor.sessions.RequestFrameLiveViewRequest} request
+     * @param {LiveViewClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.ForbiddenError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.ConflictError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.liveView.requestFrame({
+     *         id: "id",
+     *         body: {}
+     *     })
+     */
+    requestFrame(request: Lusor.sessions.RequestFrameLiveViewRequest, requestOptions?: LiveViewClient.RequestOptions): core.HttpResponsePromise<Lusor.StreamCommandResult>;
+    private __requestFrame;
+    /**
+     * Relays the client's side of the WebRTC handshake to the phone.
+     * `message.type` must be `webrtc_answer` or `webrtc_ice`; the rest of
+     * `message` is passed to the phone unchanged.
+     *
+     * **Retries:** safe without an `Idempotency-Key`: short-lived live-view connection control that changes nothing on the phone.
+     *
+     * @param {Lusor.sessions.StreamSignalInput} request
+     * @param {LiveViewClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.ForbiddenError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.ConflictError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.liveView.signal({
+     *         id: "id",
+     *         message: {
+     *             type: "webrtc_answer"
+     *         }
+     *     })
+     */
+    signal(request: Lusor.sessions.StreamSignalInput, requestOptions?: LiveViewClient.RequestOptions): core.HttpResponsePromise<Lusor.StreamCommandResult>;
+    private __signal;
+    /**
+     * **Retries:** safe without an `Idempotency-Key`: short-lived live-view connection control that changes nothing on the phone.
+     *
+     * @param {Lusor.sessions.StreamStopInput} request
+     * @param {LiveViewClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.ForbiddenError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.ConflictError}
+     * @throws {@link Lusor.BadGatewayError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.liveView.stop({
+     *         id: "id"
+     *     })
+     */
+    stop(request: Lusor.sessions.StreamStopInput, requestOptions?: LiveViewClient.RequestOptions): core.HttpResponsePromise<Lusor.StreamCommandResult>;
+    private __stop;
+    /**
+     * The STUN/TURN configuration for the client's `RTCPeerConnection`.
+     * The phone gets the same TURN allocation, so pass these to the
+     * browser unchanged. `iceServers` is null when TURN is not available;
+     * fall back to STUN. Rotating the credential during a live view is
+     * not available through the API yet: after `expiresAt`, start a new
+     * live view.
+     *
+     * @param {Lusor.sessions.IceServersLiveViewRequest} request
+     * @param {LiveViewClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Lusor.BadRequestError}
+     * @throws {@link Lusor.UnauthorizedError}
+     * @throws {@link Lusor.ForbiddenError}
+     * @throws {@link Lusor.NotFoundError}
+     * @throws {@link Lusor.ConflictError}
+     * @throws {@link errors.LusorError}
+     * @throws {@link errors.LusorTimeoutError}
+     *
+     * @example
+     *     await client.sessions.liveView.iceServers({
+     *         id: "id"
+     *     })
+     */
+    iceServers(request: Lusor.sessions.IceServersLiveViewRequest, requestOptions?: LiveViewClient.RequestOptions): core.HttpResponsePromise<Lusor.sessions.IceServersLiveViewResponse>;
+    private __iceServers;
+    /**
+     * A Server-Sent Events stream. Each event is named `signal` and its
+     * `data` is one JSON signaling message from the phone, identified by
+     * its `action` (for example `webrtc_offer`, `webrtc_ice`,
+     * `stream_ready`). A `keep-alive` comment arrives every 15 seconds.
+     * The stream stays open until the client disconnects.
+     */
+    events(request: Lusor.sessions.EventsLiveViewRequest, requestOptions?: LiveViewClient.RequestOptions): core.HttpResponsePromise<core.Stream<Lusor.StreamSignalEvent>>;
+    private __events;
+}