Class: Google::Cloud::Video::Stitcher::V1::Event

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/video/stitcher/v1/events.rb

Overview

Describes an event and a trigger URI.

Defined Under Namespace

Modules: EventType

Instance Attribute Summary collapse

Instance Attribute Details

#id ⇒ ::String

Returns The ID of the event.

Returns:

  • (::String) —

    The ID of the event.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/video/stitcher/v1/events.rb', line 38

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the event that occurred.
  module EventType
    # The event type is unspecified.
    EVENT_TYPE_UNSPECIFIED = 0

    # First frame of creative ad viewed.
    CREATIVE_VIEW = 1

    # Creative ad started.
    START = 2

    # Start of an ad break.
    BREAK_START = 3

    # End of an ad break.
    BREAK_END = 4

    # Impression.
    IMPRESSION = 5

    # First quartile progress.
    FIRST_QUARTILE = 6

    # Midpoint progress.
    MIDPOINT = 7

    # Third quartile progress.
    THIRD_QUARTILE = 8

    # Ad progress completed.
    COMPLETE = 9

    # Specific progress event with an offset.
    PROGRESS = 10

    # Player muted.
    MUTE = 11

    # Player unmuted.
    UNMUTE = 12

    # Player paused.
    PAUSE = 13

    # Click event.
    CLICK = 14

    # Click-through event.
    CLICK_THROUGH = 15

    # Player rewinding.
    REWIND = 16

    # Player resumed.
    RESUME = 17

    # Error event.
    ERROR = 18

    # Ad expanded to a larger size.
    EXPAND = 21

    # Ad collapsed to a smaller size.
    COLLAPSE = 22

    # Non-linear ad closed.
    CLOSE = 24

    # Linear ad closed.
    CLOSE_LINEAR = 25

    # Ad skipped.
    SKIP = 26

    # Accept invitation event.
    ACCEPT_INVITATION = 27
  end
end

#offset ⇒ ::Google::Protobuf::Duration

Returns The offset in seconds if the event type is PROGRESS.

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/video/stitcher/v1/events.rb', line 38

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the event that occurred.
  module EventType
    # The event type is unspecified.
    EVENT_TYPE_UNSPECIFIED = 0

    # First frame of creative ad viewed.
    CREATIVE_VIEW = 1

    # Creative ad started.
    START = 2

    # Start of an ad break.
    BREAK_START = 3

    # End of an ad break.
    BREAK_END = 4

    # Impression.
    IMPRESSION = 5

    # First quartile progress.
    FIRST_QUARTILE = 6

    # Midpoint progress.
    MIDPOINT = 7

    # Third quartile progress.
    THIRD_QUARTILE = 8

    # Ad progress completed.
    COMPLETE = 9

    # Specific progress event with an offset.
    PROGRESS = 10

    # Player muted.
    MUTE = 11

    # Player unmuted.
    UNMUTE = 12

    # Player paused.
    PAUSE = 13

    # Click event.
    CLICK = 14

    # Click-through event.
    CLICK_THROUGH = 15

    # Player rewinding.
    REWIND = 16

    # Player resumed.
    RESUME = 17

    # Error event.
    ERROR = 18

    # Ad expanded to a larger size.
    EXPAND = 21

    # Ad collapsed to a smaller size.
    COLLAPSE = 22

    # Non-linear ad closed.
    CLOSE = 24

    # Linear ad closed.
    CLOSE_LINEAR = 25

    # Ad skipped.
    SKIP = 26

    # Accept invitation event.
    ACCEPT_INVITATION = 27
  end
end

#type ⇒ ::Google::Cloud::Video::Stitcher::V1::Event::EventType

Returns Describes the event that occurred.

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/video/stitcher/v1/events.rb', line 38

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the event that occurred.
  module EventType
    # The event type is unspecified.
    EVENT_TYPE_UNSPECIFIED = 0

    # First frame of creative ad viewed.
    CREATIVE_VIEW = 1

    # Creative ad started.
    START = 2

    # Start of an ad break.
    BREAK_START = 3

    # End of an ad break.
    BREAK_END = 4

    # Impression.
    IMPRESSION = 5

    # First quartile progress.
    FIRST_QUARTILE = 6

    # Midpoint progress.
    MIDPOINT = 7

    # Third quartile progress.
    THIRD_QUARTILE = 8

    # Ad progress completed.
    COMPLETE = 9

    # Specific progress event with an offset.
    PROGRESS = 10

    # Player muted.
    MUTE = 11

    # Player unmuted.
    UNMUTE = 12

    # Player paused.
    PAUSE = 13

    # Click event.
    CLICK = 14

    # Click-through event.
    CLICK_THROUGH = 15

    # Player rewinding.
    REWIND = 16

    # Player resumed.
    RESUME = 17

    # Error event.
    ERROR = 18

    # Ad expanded to a larger size.
    EXPAND = 21

    # Ad collapsed to a smaller size.
    COLLAPSE = 22

    # Non-linear ad closed.
    CLOSE = 24

    # Linear ad closed.
    CLOSE_LINEAR = 25

    # Ad skipped.
    SKIP = 26

    # Accept invitation event.
    ACCEPT_INVITATION = 27
  end
end

#uri ⇒ ::String

Returns The URI to trigger for this event.

Returns:

  • (::String) —

    The URI to trigger for this event.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/video/stitcher/v1/events.rb', line 38

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the event that occurred.
  module EventType
    # The event type is unspecified.
    EVENT_TYPE_UNSPECIFIED = 0

    # First frame of creative ad viewed.
    CREATIVE_VIEW = 1

    # Creative ad started.
    START = 2

    # Start of an ad break.
    BREAK_START = 3

    # End of an ad break.
    BREAK_END = 4

    # Impression.
    IMPRESSION = 5

    # First quartile progress.
    FIRST_QUARTILE = 6

    # Midpoint progress.
    MIDPOINT = 7

    # Third quartile progress.
    THIRD_QUARTILE = 8

    # Ad progress completed.
    COMPLETE = 9

    # Specific progress event with an offset.
    PROGRESS = 10

    # Player muted.
    MUTE = 11

    # Player unmuted.
    UNMUTE = 12

    # Player paused.
    PAUSE = 13

    # Click event.
    CLICK = 14

    # Click-through event.
    CLICK_THROUGH = 15

    # Player rewinding.
    REWIND = 16

    # Player resumed.
    RESUME = 17

    # Error event.
    ERROR = 18

    # Ad expanded to a larger size.
    EXPAND = 21

    # Ad collapsed to a smaller size.
    COLLAPSE = 22

    # Non-linear ad closed.
    CLOSE = 24

    # Linear ad closed.
    CLOSE_LINEAR = 25

    # Ad skipped.
    SKIP = 26

    # Accept invitation event.
    ACCEPT_INVITATION = 27
  end
end