Skip to main content
Corvus Connection

On Ad Break Begin

Twitch
Trigger
entry.onAdBreakBeginFires when an ad break starts. Binds the break length, whether it was automatic, and who ran it.Triggers when an ad break begins.Requires the channel:read:ads scope.
MonetizationLifecycle

Outputs

Name
Kind
Type
Flags
out
Exec
exec
None
durationSeconds
Data
System.Int32
multiplexed
isAutomatic
Data
System.Boolean
multiplexed
requesterName
Data
System.String
multiplexed
startedAt
Data
System.DateTime
multiplexed
  • Name
    out
    Kind
    Exec
    Type
    exec
    Flags
    None
  • Name
    durationSeconds
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    isAutomatic
    Kind
    Data
    Type
    System.Boolean
    Flags
    multiplexed
  • Name
    requesterName
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    startedAt
    Kind
    Data
    Type
    System.DateTime
    Flags
    multiplexed

Bindings

Name
Type
Description
durationSeconds
System.Int32
The ad break's length in seconds.
isAutomatic
System.Boolean
True when the ad break was scheduled automatically.
requesterName
System.String
The display name of whoever started the ad break.
startedAt
System.DateTime
When the ad break started (UTC).
  • Name
    durationSeconds
    Type
    System.Int32
    Description
    The ad break's length in seconds.
  • Name
    isAutomatic
    Type
    System.Boolean
    Description
    True when the ad break was scheduled automatically.
  • Name
    requesterName
    Type
    System.String
    Description
    The display name of whoever started the ad break.
  • Name
    startedAt
    Type
    System.DateTime
    Description
    When the ad break started (UTC).

Parameters

Name
Type
Required
Default
Choices
cooldownSeconds
System.Int32
no
0
None
perUserCooldownSeconds
System.Int32
no
0
None
debounceMs
System.Int32
no
0
None
dedupeKey
System.String
no
""
None
maxConcurrency
System.Int32
no
0
None
  • Name
    cooldownSeconds
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    perUserCooldownSeconds
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    debounceMs
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    dedupeKey
    Type
    System.String
    Required
    no
    Default
    ""
    Choices
    None
  • Name
    maxConcurrency
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None

Lowers to C#

[OnAdBreakBegin] Handle(ctx, AdBreakBeginContext e)