Hiyve Components - v1.0.0
    Preparing search index...

    Interface HiyveServerConfig

    Configuration for Hiyve server middleware.

    Provides the credentials and region information needed by all Hiyve server endpoints. Use loadHiyveConfig to populate from env vars.

    const config: HiyveServerConfig = {
      apiKey: 'pk_live_xxx',
      clientSecret: 'cs_xxx',
      region: 'us-west-2',
    };
    interface HiyveServerConfig {
        apiKey: string;
        clientSecret: string;
        cloudApiUrl?: string;
        environment?: string;
        region?: string;
        regionUrl?: string;
    }
    Index

    Properties

    apiKey clientSecret cloudApiUrl? environment? region? regionUrl?

    Properties

    apiKey: string

    API key for Hiyve signaling server and cloud API

    clientSecret: string

    Client secret for Hiyve signaling server

    cloudApiUrl?: string

    Override cloud API URL (auto-derived from environment if not set)

    environment?: string

    Environment: 'production' or 'development' (default: 'development')

    region?: string

    Server region (default: 'us-west-2')

    regionUrl?: string

    Region URL suffix (default: '.rtc.muziemedia.com')

    Settings

    Member Visibility

    On This Page

    Properties