@openstream/client/dist/defs/constants.d.ts

Openstream Radio Server Client

/** Access token header used in API endpoints */
export declare const ACCESS_TOKEN_HEADER = "x-access-token";
/** access token autoremove validity
 *  remove access tokens that are not used in the last X time
 *  this is only for Login, Register or AdminAsUser access tokens
 *  Cli or Api(not AdminAsUser) access tokens does not auto-expire */
export declare const ACCESS_TOKEN_NOT_USED_AUTOREMOVE_SECS = 604800;
/** time in seconds for which an account invitation can be accepted (or rejected) */
export declare const ACCOUNT_INVITATION_VALIDITY_SECS = 604800;
/** limit of authotization, or other sensible api endpoints requests from the same ip */
export declare const API_IP_LIMIT = 60;
/** limit restart interval of API_IP_LIMIT */
export declare const API_IP_LIMIT_DURATION_SECS = 60;
/** audio file byte rate */
export declare const AUDIO_FILE_BYTERATE = 16000;
/** audio file chunk size in bytes */
export declare const AUDIO_FILE_CHUNK_SIZE = 256000;
export declare const DEPLOYMENT_HEALTH_CHECK_INTERVAL_SECS = 1;
export declare const DEPLOYMENT_HEALTH_CHECK_SHUTDOWN_DELAY_SECS = 240;
export declare const DEPLOYMENT_HEALTH_CHECK_SHUTDOWN_INTERVAL_SECS = 10;
/** time in seconds for which an email verification code is valid */
export declare const EMAIL_VERIFICATION_CODE_LEN = 6;
/** time in seconds for which an email verification code is valid */
export declare const EMAIL_VERIFICATION_VALIDITY_SECS = 3600;
/** delay of which if external relay produced no data, it will be cancelled */
export declare const EXTERNAL_RELAY_NO_DATA_SHUTDOWN_SECS = 30;
/** delay of which if external doesn't produce first data chunk, it will be cancelled */
export declare const EXTERNAL_RELAY_NO_DATA_START_SHUTDOWN_SECS = 90;
export declare const EXTERNAL_RELAY_NO_LISTENERS_SHUTDOWN_DELAY_SECS = 60;
export declare const EXTERNAL_RELAY_NO_LISTENERS_SHUTDOWN_INTERVAL_SECS = 20;
/** Internal forwarded ip header used when openstream servers are connecting with each other */
export declare const FORWARD_IP_HEADER = "x-openstream-forwarded-ip";
export declare const HEADER_RELAY_SOURCE_DEPLOYMENT = "x-source-deployment";
/** Internal relay rejection code header */
export declare const INTERNAL_RELAY_REJECTION_CODE_HEADER = "x-openstream-rejection-code";
/** header name to get the result of the stream is-hls-redirect query */
export declare const IS_HLS_REDIRECT_HEADER = "x-is-hls-redirect";
/** timeout to wait to obtain a lock on a media session items
 *  if not released in this timeout, probably the item is poisoned
 *  and the process is aborted with a panic (and restarted by the process manager) */
export declare const MEDIA_LOCK_TIMEOUT_SECS = 30;
export declare const MEDIA_RELAY_TIMEOUT_SECS = 35;
/** interval in which
 *  $stations.owner_deployment_info.health_checked_at
 *  and $media_session.health_checked_at
 *  will be set to $NOW */
export declare const MEDIA_SESSION_HEALTH_CHECK_INTERVAL_SECS = 6;
/** interval to check if $stations.owner_deployment_info and $media_sessions are healthy */
export declare const MEDIA_SESSION_HEALTH_CHECK_KILL_INTERVAL_SECS = 5;
/** time to check if a $media_session (and $station.owner_deployment_info) is healthy
 *  otherwise kill it in database */
export declare const MEDIA_SESSION_HEALTH_SHUTDOWN_TIMEOUT_SECS = 33;
/** Access token header used by payments servers implementations */
export declare const PAYMENTS_ACCESS_TOKEN_HEADER = "x-access-token";
/** delay to shutdown a playlist media session when it run out of listeners */
export declare const PLAYLIST_NO_LISTENERS_SHUTDOWN_DELAY_SECS = 10;
/** internal interval to start new probe task if needed */
export declare const PROBE_BACKGROUND_JOB_CHECK_INTERVAL_SECS = 10;
/** interval to run a probe request (multiplied by the number of stations) */
export declare const PROBE_STATION_INTERVAL_SECS = 300;
/** External ip header used for connecting from a reverse proxy */
export declare const REAL_IP_HEADER = "x-real-ip";
/** delay to shutdown a relay session when it run out of listeners */
export declare const RELAY_NO_LISTENERS_SHUTDOWN_DELAY_SECS = 10;
/** we need to update this value after making code changes to the station pictures logic or sizes
 *  changing to this value will make startup check and recreation of outdated images
 *  and invalidation of service workers station pictures caches */
export declare const STATION_PICTURES_VERSION = 5;
/** stream bust len in elements (use with STREAM_CHUNK_SIZE) */
export declare const STREAM_BURST_LENGTH = 12;
/** stream tokio broadcaster stream channel capacity */
export declare const STREAM_CHANNEL_CAPACITY = 16;
/** stream chunk size */
export declare const STREAM_CHUNK_SIZE = 16000;
/** open connections that last more than this time in seconds will be terminated */
export declare const STREAM_CONNECTION_MAX_DURATION_SECS = 21600;
/** limit of concurrent stream connections from the same ip */
export declare const STREAM_IP_CONNECTIONS_LIMIT = 8;
/** stream kbps */
export declare const STREAM_KBITRATE = 128;
/** time in seconds for which an user recovery token code is valid */
export declare const TOKEN_USER_RECOVERY_VALIDITY_SECS = 3600;
/** station's transfer save interval in milliseconds */
export declare const TRANSFER_SAVE_INTERVAL_MILLIS = 5000;
export declare const VALIDATE_ACCESS_TOKEN_TITLE_MAX_LEN = 150;
export declare const VALIDATE_ACCOUNT_NAME_MAX_LEN = 60;
export declare const VALIDATE_ACCOUNT_NAME_MIN_LEN = 1;
export declare const VALIDATE_ADMIN_EMAIL_MAX_LEN = 100;
export declare const VALIDATE_ADMIN_FIRST_NAME_MAX_LEN = 100;
export declare const VALIDATE_ADMIN_LANGUAGE_MAX_LEN = 100;
export declare const VALIDATE_ADMIN_LAST_NAME_MAX_LEN = 100;
export declare const VALIDATE_ADMIN_PASSWORD_MAX_LEN = 60;
export declare const VALIDATE_ADMIN_PASSWORD_MIN_LEN = 8;
export declare const VALIDATE_AUDIO_FILE_METADATA_ALBUM_ARTIST_MAX_LEN = 100;
export declare const VALIDATE_AUDIO_FILE_METADATA_ALBUM_MAX_LEN = 100;
export declare const VALIDATE_AUDIO_FILE_METADATA_ARTIST_MAX_LEN = 100;
export declare const VALIDATE_AUDIO_FILE_METADATA_COMMENT_MAX_LEN = 100;
export declare const VALIDATE_AUDIO_FILE_METADATA_GENRE_MAX_LEN = 100;
export declare const VALIDATE_AUDIO_FILE_METADATA_TITLE_MAX_LEN = 100;
export declare const VALIDATE_PLAN_IDENTIFIER_MAX_LEN = 100;
export declare const VALIDATE_PLAN_NAME_MAX_LEN = 100;
export declare const VALIDATE_PLAN_SLUG_MAX_LEN = 100;
export declare const VALIDATE_STATION_DESC_MAX_LEN = 4000;
export declare const VALIDATE_STATION_DESC_MIN_LEN = 1;
export declare const VALIDATE_STATION_EMAIL_MAX_LEN = 100;
export declare const VALIDATE_STATION_EXTERNAL_RELAY_URL_MAX_LEN = 2000;
export declare const VALIDATE_STATION_FREQUENCY_MAX = 100000;
export declare const VALIDATE_STATION_FREQUENCY_MIN = 0;
export declare const VALIDATE_STATION_NAME_MAX_LEN = 60;
export declare const VALIDATE_STATION_NAME_MIN_LEN = 1;
export declare const VALIDATE_STATION_PHONE_MAX_LEN = 60;
export declare const VALIDATE_STATION_SLOGAN_MAX_LEN = 100;
export declare const VALIDATE_STATION_SLOGAN_MIN_LEN = 1;
export declare const VALIDATE_STATION_SLUG_MAX_LEN = 60;
export declare const VALIDATE_STATION_SLUG_MIN_LEN = 1;
export declare const VALIDATE_STATION_URLS_MAX_LEN = 200;
export declare const VALIDATE_STATION_WHATSAPP_MAX_LEN = 60;
export declare const VALIDATE_USER_EMAIL_MAX_LEN = 100;
export declare const VALIDATE_USER_FIRST_NAME_MAX_LEN = 100;
export declare const VALIDATE_USER_LANGUAGE_MAX_LEN = 100;
export declare const VALIDATE_USER_LAST_NAME_MAX_LEN = 100;
export declare const VALIDATE_USER_PASSWORD_MAX_LEN = 60;
export declare const VALIDATE_USER_PASSWORD_MIN_LEN = 8;
export declare const VALIDATE_USER_PHONE_MAX_LEN = 40;
//# sourceMappingURL=constants.d.ts.map