SqueezeEventConfig

Swagger API Documentation

Summary

SqueezeEventConfig defines event-specific squeezeback configuration for individual live streaming events. It inherits defaults from the associated SqueezeBrandConfig - if a parameter is not set (0 or empty), it automatically inherits the value from the brand configuration.

Use Cases

  • Configure squeezeback for specific live events
  • Override brand defaults for special events
  • Define source URIs and DRM settings per event
  • Schedule events with specific start times
  • Control event lifecycle (None → Running → Ended)

Key Configuration Areas

Event Identity & Scheduling:

  • Event name, description, and unique asset ID
  • Scheduled start time for event planning
  • Event lifecycle state management

Source Configuration:

  • HLS and DASH source manifest URIs
  • DRM key JWT tokens for protected content
  • Generated streaming URLs (computed)

Squeezeback Parameters:

  • Inherits all visual parameters from SqueezeBrandConfig
  • Box positions, sizes, and animation settings
  • Frame styling and appearance
  • Can override brand defaults on a per-event basis

Operational Settings:

  • Manifest polling intervals
  • Concurrent stream limits
  • Sliding window segment counts

Inheritance Behavior: Event parameters inherit from the associated SqueezeBrandConfig when not explicitly set (0 for numbers, empty for strings).

Ad Tag Override

The ad_tag_override field allows per-event customization of Freewheel ad server parameters. This is a JSON object where any included parameters will override the default values used when generating Freewheel ad tag URLs.

Common Parameters

See the Swagger API Documentation for a complete list of Freewheel parameters that can be overridden. Commonly configured parameters include:

  • csid - Site Section ID (identifies platform, device, and stream type)
  • prof - Network Profile (identifies ad serving profile configuration)
  • resp - Response format from Freewheel (e.g., vmap1, vmap1+vast4)
  • nw, asnw, ssnw - Network identifiers
  • vdur - Video duration in seconds
  • sb - Subscriber Package ID (subscription tier)

Notes on Ad Tag Override

  • Only specified parameters are overridden; others use defaults
  • Contact your ad operations team to verify correct parameter values for your campaigns

API Documentation

See the Swagger API Documentation for complete API details including endpoints, request/response schemas, parameters, and examples.

Event States

State Description
None Event configured but not yet started
Running Event currently active and accepting streams
Extended Event extended beyond original end time (can also apply to ad breaks)
Ended Event finished

Streaming URL

The event_stream_url field is computed dynamically based on the request context and is not persisted in the database.

Inheritance Behavior

Event parameters inherit from the associated SqueezeBrandConfig when not explicitly set (0 for numbers, empty for strings). Event-specific values override brand defaults when provided.

Notes

  • asset_id must be unique across all events
  • event_stream_url is read-only (computed field)
  • Setting squeeze parameters to 0 triggers brand inheritance
  • DRM JWT tokens should be generated per-event for security
  • Update event_state to control event lifecycle
  • ad_tag_override allows per-event Freewheel parameter customization (see Ad Tag Override section)