openvibe-sdk/delivery

Generated at from openvibe-contracts v0.107.0 and openvibe-sdk v0.35.0.

From types/delivery.d.ts (server only). Declarations are shown verbatim.

type DeliveryOfferCacheRules

platform.delivery-offer@1: transport and edge delivery capacity with cache policy and pricing. Validated by openvibe-contracts (required lazily by validateDeliveryOffer).

export type DeliveryOfferCacheRules = { enabled: boolean; ttl_seconds?: number; max_object_mb?: number };

type DeliveryOffer

export type DeliveryOffer = { id: string; transports: ('http' | 'hls' | 'rtmp' | 'srt' | 'ws')[]; regions: string[];
    edge: boolean; node?: string; price_per_gb_usd: number; price_per_request_usd: number; cache_rules: DeliveryOfferCacheRules };

type ValidationError

export type ValidationError = { path: string; message: string };

function deliveryOffer

Null/undefined fields are stripped.

export declare function deliveryOffer(fields: Partial<DeliveryOffer>): DeliveryOffer;

function validateDeliveryOffer

export declare function validateDeliveryOffer(record: unknown): { ok: boolean; errors: ValidationError[] };