SqueezeBrandConfig

Swagger API Documentation

Summary

SqueezeBrandConfig maintains brand-level default configurations for squeezeback operations. These settings define the visual appearance and behavior of squeezeback layouts and serve as defaults that can be overridden at the event level via SqueezeEventConfig.

Use Cases

  • Set consistent squeezeback parameters across all events for a brand
  • Define default box positions, sizes, and animations
  • Configure frame styling (thickness, colors) for brand identity
  • Set concurrent stream limits for capacity planning

Key Configuration Parameters

Box Positioning & Sizing:

  • Squeeze ratios control box sizes (0.1-1.0)
  • Position values are percentages from edges (0.0-1.0)
  • Separate controls for content and ad boxes

Visual Appearance:

  • Frame borders with configurable thickness and colors
  • Animation durations for squeeze-in/squeeze-out transitions
  • Banner sources for branding elements

Operational Settings:

  • Maximum concurrent streams for capacity planning
  • Manifest polling intervals for live events

API Documentation

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

Notes

  • All position values are percentages (0.0 to 1.0)
  • Squeeze ratios represent the amount to squeeze (not the final size)
  • Frame colors use format: "colorname@opacity" (e.g., “white@0.8” for 80% opaque white)
  • Setting max_concurrents to 0 removes the limit
  • Changes to brand config do not automatically update existing events (use event-level overrides)