Init & Config
⚡ 5 min readThe Transcodes SDK has two modes: Static (PWA) and Dynamic (CDN / npm). The Dynamic SDK requires init({ projectId }) before use
API Modes
| Mode | Entry Point | Config source | Extra methods |
|---|---|---|---|
| Static | PWA build | Build-time | showMessage() |
| Dynamic | CDN or npm | Runtime init() | init(), setConfig(), isInitialized(), getBuildInfo() |
TranscodesInitOptions
interface TranscodesInitOptions {
/** Project ID from Transcodes dashboard */
projectId: string;
}Other runtime options (e.g. rpId, branding) are injected at build time for the Dynamic bundle where applicable.
init() (Dynamic SDK only)
transcodes.init(options: TranscodesInitOptions): Promise<void>Example:
await transcodes.init({
projectId: 'proj_abc123xyz',
});Call init() before openAuthLoginModal, token, member, etc.
setConfig() (Dynamic SDK only)
transcodes.setConfig(options: { memberId?: string }): voidExample:
transcodes.setConfig({ memberId: 'external_member_ref' });To change projectId, call init() again with new options
isInitialized() (Dynamic SDK only)
transcodes.isInitialized(): booleanExample:
if (transcodes.isInitialized()) {
const member = await transcodes.token.getCurrentMember();
} else {
await transcodes.init({ projectId: 'proj_xxx' });
}getBuildInfo() (Dynamic SDK only)
transcodes.getBuildInfo(): TranscodesBuildInfointerface TranscodesBuildInfo {
buildTimestamp: string;
}isPwaInstalled()
transcodes.isPwaInstalled(): booleanType Definitions
TranscodesStaticAPI
interface TranscodesStaticAPI extends TranscodesBaseAPI {
showMessage: (message: string) => void;
}TranscodesDynamicAPI
interface TranscodesDynamicAPI extends TranscodesBaseAPI {
init: (options: TranscodesInitOptions) => Promise<void>;
setConfig: (options: { memberId?: string }) => void;
isInitialized: () => boolean;
getBuildInfo: () => TranscodesBuildInfo;
}Related
Last updated on