AVP 3DWS Deck Documentation
    Preparing search index...

    Type Alias DeckConnectedEvent

    Event that fires when the stream is connected to the server and ready to receive commands. The car and the environment are not yet loaded at this point.

    CustomEvent of type connected differing slightly in its detail depending on if a cloud AVE or local AVE is used.

    When connecting to a cloud instance, the detail will contain a sessionId of the established streaming session.

    .addEventListener('connected', (event) => {
    if (event.detail.sessionId) {
    console.log("Connected via session token. Session ID:", event.detail.sessionId);
    }
    })

    When connecting to a local AVE via setConnection, the detail will contain a channelName the signaling channel name.

    .addEventListener('connected', (event) => {
    if (event.detail.channelName) {
    console.log("Connected to local AVE. Channel name:", event.detail.channelName);
    }
    })
    type DeckConnectedEvent = {
        detail: {
            channelName?: string;
            sessionId?: DeckHtmlAttributes["session-id"];
        };
        type: "connected";
    }
    Index

    Properties

    Properties

    detail: { channelName?: string; sessionId?: DeckHtmlAttributes["session-id"] }
    type: "connected"