Function: getMedia()
Downloads media from typed GET routes. Returns binary for image/envmap formats, and binary + metadata for model formats.
Call Signature
getMedia<
T>(client,props,binaryResponse?):Promise<BinaryResponseType<T>>
Type Parameters
T
T extends BinaryResponse
Parameters
client
props
{ params: { orgName: string; projectName: string; assetName: string; version?: string; }; format: "webp"; query?: object & object; } | { params: { orgName: string; projectName: string; assetName: string; version?: string; }; format: "exr" | "hdr" | "jxl" | "ultrahdr"; query?: { download?: boolean; original?: boolean; }; }
binaryResponse?
T
Returns
Promise<BinaryResponseType<T>>
Call Signature
getMedia<
T>(client,props,binaryResponse?):Promise<{data:BinaryResponseType<T>;fileName:string|undefined;mimeType:string|undefined; }>
Type Parameters
T
T extends BinaryResponse
Parameters
client
props
{ params: { orgName: string; projectName: string; assetName: string; version?: string; }; format: "glb"; query?: { original?: boolean; download?: boolean; meshCompress?: string; textureCompress?: string; }; } | { params: { orgName: string; projectName: string; assetName: string; version?: string; }; format: "usdz"; query?: { download?: boolean; original?: boolean; }; } | { params: { orgName: string; projectName: string; assetName: string; version?: string; }; format: "blend"; query?: { download?: boolean; original?: boolean; }; } | { params: { orgName: string; projectName: string; assetName: string; version?: string; }; format: "fbx"; query?: { download?: boolean; original?: boolean; }; } | { params: { orgName: string; projectName: string; assetName: string; version?: string; }; format: "fcstd"; query?: { download?: boolean; original?: boolean; }; } | { params: { orgName: string; projectName: string; assetName: string; version?: string; }; format: "iges"; query?: { download?: boolean; original?: boolean; }; } | { params: { orgName: string; projectName: string; assetName: string; version?: string; }; format: "step"; query?: { download?: boolean; original?: boolean; }; }
binaryResponse?
T
Returns
Promise<{ data: BinaryResponseType<T>; fileName: string | undefined; mimeType: string | undefined; }>