Launch API

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

Path parameter	Alternatives	Description
application	validate, edit, poster, subtitle	The application to load

Launch Template

Query parameter	Description
launchTemplate	The launch template url to load
manual	If "true", gives you the possibility to edit the contents of the launch template before proceeding

License key

Query parameter	Description
licenseKey	The 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 parameter	Alternatives	Default	Description
authMethod	none, oidc, token	none	Determines what authentication method to use

OIDC

Additional query parameters relevant if you configure oidc as authMethod:

Query parameter	Required	Alternatives	Default	Description
authOIDCAuthority	Yes			The URL of the OIDC/OAuth2 provider
authOIDCClientId	Yes			Your client application's identifier as registered with the OIDC/OAuth2
authOIDCResponseType	No		code	The type of response desired from the OIDC/OAuth2 provider
authOIDCScope	No		openid email profile	The scope being requested from the OIDC/OAuth2 provider
authOIDCTokenType	No	access, id	access	The token to use in the Authorization header on requests
authOIDCRedirectUri	No		Default redirect URI	The 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.
authOIDCLogoutRedirectUri	No		Default redirect URI	The 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 parameter	Default	Description
authTokenParameter	token	The query parameter that the token should be read from
authTokenPrefix	Bearer	The token prefix that will be used in the Authorization header. ex: Authorization {prefix} {token}

Application

Query parameter	Default	Description
frame	0	The initial frame to seek to when loading the application
components		The components that are enabled when the application loads. It accepts a comma-separated list of component IDs. 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

Components query parameter

The components that are enabled when the application loads. It accepts a comma-separated list of component IDs. This list is updated automatically by the app, ensuring that the component state is kept when reloading the page.

Format

Each component contains only the file ID. Unlike in Validate, specifying tracks or enabling/disabling audio channels is not supported in Subtitle. This limitation exists because Subtitle does not support processing files with multiple tracks or channel selection.

---

Examples

• Enable a single component:

• ?components=VX-1

• Enables the component VX-1

• Enable multiple components:

• ?components=VX-1,VX-2

• Enables both VX-1 and VX-2