Skip to main content

Launch API

These parameters can be used when using the Launch API: /launch/:application.

Path parameterAlternativesDescription
applicationvalidate, edit, poster, subtitleThe application to load

Launch Template​

Query parameterDescription
launchTemplateThe launch template url to load
manualIf "true", gives you the possibility to edit the contents of the launch template before proceeding

License key​

Query parameterDescription
licenseKeyThe license key for Accurate Video
info

The licenseKey specified in query parameters takes precedence over the licenseKey specified in the launch template

Authentication​

You can configure authentication by providing a set of query parameters when opening a launch template.

info

You can read more in our how-to-guide How to use authentication

General authentication parameters​

Query parameterAlternativesDefaultDescription
authMethodnone, oidc, tokennoneDetermines what authentication method to use

OIDC​

Additional query parameters relevant if you configure oidc as authMethod:

Query parameterRequiredAlternativesDefaultDescription
authOIDCAuthorityYesThe URL of the OIDC/OAuth2 provider
authOIDCClientIdYesYour client application's identifier as registered with the OIDC/OAuth2
authOIDCResponseTypeNocodeThe type of response desired from the OIDC/OAuth2 provider
authOIDCScopeNoopenid email profileThe scope being requested from the OIDC/OAuth2 provider
authOIDCTokenTypeNoaccess, idaccessThe token to use in the Authorization header on requests
authOIDCRedirectUriNoDefault redirect URIThe redirect URI of Accurate.Video to receive a response from the OIDC/OAuth2 provider on login. This should be set to the uri where Accurate.Video is hosted. You probably do not need to change this unless you are hosting Accurate.Video from a subpath on your domain.
authOIDCLogoutRedirectUriNoDefault redirect URIThe redirect URI of Accurate.Video to receive a response from the OIDC/OAuth2 provider on logout. This should be set to the uri where Accurate.Video is hosted. You probably do not need to change this unless you are hosting Accurate.Video from a subpath on your domain.
Default redirect URI​

The default authOIDCRedirectUri and authOIDCLogoutRedirectUri is calculated in the following way:

const url = new URL(window.location.href);
const finalRedirectUri = `${url.origin}${url.pathname}`;

For example, for this URL

https://apps.accurate.video/launch/validate
    ?launchTemplate=https://example.com/launch-template.json
    &authMethod=oidc
    &authOIDCAuthority=https://example.com/authority
    &authOIDCClientId=5g3srbv1u6q6t97u8m7tcj3dd8

the default authOIDCRedirectUri and authOIDCLogoutRedirectUri would result in https://apps.accurate.video/launch/validate.

Token​

Additional query parameters relevant if you configure token as authMethod:

Query parameterDefaultDescription
authTokenParametertokenThe query parameter that the token should be read from
authTokenPrefixBearerThe token prefix that will be used in the Authorization header. ex: Authorization {prefix} {token}

Application​

Query parameterAlternativesDefaultDescription
frame0The initial frame to seek to when loading the application
componentsThe components that are enabled when the application loads. It accepts a comma-separated list of component IDs, with optional information about which tracks and channels should be active. This list is updated automatically by the app, ensuring that the component state is kept when reloading the page.
For a detailed description see Components query parameter
workspaceGeneral, Audio, AdbreakGeneralDetermines what workspace to open at the initial load

Components query parameter​

The components that are enabled when the application loads. It accepts a comma-separated list of component IDs, with optional information about which tracks and channels should be active. This list is updated automatically by the app, ensuring that the component state is kept when reloading the page.

Format​

The format for each component is as follows:

id(track)(enabled-channels)

Breakdown​

  • id
    The ID of the file.

  • track (Optional)
    Specifies the track to be used. It can be one of the following:

  • V: Selects a video track. This is useful when multiple proxies are available. Video tracks are specified without channels.

  • A number (e.g., 0): Selects an audio track by its index. This is always 0 for discrete audio tracks. For files with multiple audio tracks (e.g., from a track-extractor or JIT), the number corresponds to the specific track index.

  • A number prefixed with S (e.g., S0): Selects a subtitle track by its index. Like audio, the index is 0 for discrete subtitles but can vary for files with multiple embedded subtitle tracks. Subtitle tracks are specified without channels.

  • enabled-channels (Optional)
    Specifies the state of audio channels for a selected audio track, separated by hyphens (-). If this part is omitted for an audio track, all its channels will be enabled by default. Channels not explicitly mentioned are muted. The possible values are:

  • A number (e.g., 1): The Channel number to be enabled.

  • A number prefixed with S (e.g., S1): The Channel number to be soloed.

Examples​

  • Enable a single component:

  • ?components=VX-1

  • Enables the component VX-1. If it has audio and/or subtitles, all the tracks and channels will be enabled.

  • Enable multiple components:

  • ?components=VX-1,VX-2

  • Enables both VX-1 and VX-2 with the same logic as above. If both components contain a video track, only the first video track will be enabled

  • Specify audio tracks and channels:

  • ?components=VX-1(0)(1-S3)

  • Enables the component VX-1, selects the first audio track (index 0), enables channel 1, and solos channel 3. All other channels in this track will be muted.

  • Specify video and subtitle tracks:

  • ?components=VX-1(V),VX-1(S0)

  • Enables the VX-1 component, selects its video track (V), and also selects its first subtitle track (S0).