Skip to main content

MaestroEventData

Overview​

MaestroEventData is a data class that holds information about the currently-played event. This data is used for event-specific operations within the SDK, allowing the application to provide context about the live event being streamed or displayed.

Syntax​

data class MaestroEventData(
    val eventId: String,
    val airingId: String? = null,
    val airingName: String? = null
)

Properties​

PropertyTypeDefaultDescription
eventIdStringRequiredThe unique identifier for the event. This is the primary identifier used by the SDK to track and manage event-specific data.
airingIdString?nullOptional identifier for the specific airing or broadcast of the event. Useful when an event has multiple airings or time slots.
airingNameString?nullOptional human-readable name for the airing. This can be used for display purposes or analytics.

Usage Example​

// Create event data with only the required eventId
val eventData = MaestroEventData(
    eventId = "event-123"
)

// Create event data with airing information
val eventData = MaestroEventData(
    eventId = "event-123",
    airingId = "airing-456",
    airingName = "Sunday Night Game"
)

// Use with MaestroSDKParameters (if your SDK version supports it)
val params = MaestroSDKParameters(
    siteId = "your-site-id",
    eventData = MaestroEventData(
        eventId = "live-event-789",
        airingId = "broadcast-101",
        airingName = "Championship Final"
    )
)

// Update event data during runtime
sdkInstance.updateEventData(
    MaestroEventData(
        eventId = "new-event-456",
        airingId = "new-airing-789"
    )
)

Use Cases​

  • Live Sports: Track different games or matches with unique event IDs
  • Live Broadcasts: Manage multiple airings of the same event across different time zones
  • Event Analytics: Associate SDK interactions with specific events for better insights
  • Content Context: Provide the SDK with context about what content is currently being displayed

Notes​

  • The eventId is required and must be provided for proper event tracking
  • The airingId and airingName are optional but recommended when dealing with events that have multiple broadcasts
  • Event data can be updated during the SDK session if the user switches to a different event

See Also​

Last updated on