Video (anoa-tests 3.1.2 API)

All Superinterfaces:

Comparable<Video<?>>, Serializable, Supplier<T>

All Known Implementing Classes:

Video.Avro, Video.NativeImpl, Video.Protobuf, Video.Thrift
```
public interface Video<T>
extends Supplier<T>, Comparable<Video<?>>, Serializable
```
3.3.4 Video Object The “video” object _must_ be included directly in the impression object if the impression offered for auction is an in-stream video ad opportunity. Note that for the video object, many of the fields are non-essential for a minimally viable exchange interfaces. These parameters do not necessarily need to be specified to the bidder, if they are always the same for all impression, of if the exchange chooses not to supply the additional information to the bidder.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Video.Avro`
`static class`	`Video.AvroBuilder`
`static interface`	`Video.Builder<T>`
`static class`	`Video.Comparator`
`static class`	`Video.NativeImpl`
`static class`	`Video.Protobuf`
`static class`	`Video.ProtobufBuilder`
`static class`	`Video.Thrift`
`static class`	`Video.ThriftBuilder`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Video.Avro`	`avro(Video<?> instance)` Returns a wrapped Avro record based on an instance of Video.
`static Video.Avro`	`avro(VideoAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(Video<?> other)`
`T`	`get()` Returns underlying object.
`List<Integer>`	`getApi()` List of supported API frameworks for this impression.
`static Class<VideoAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`List<Integer>`	`getBattr()` Blocked creative attributes.
`int`	`getBoxingallowed()` If exchange publisher has rules preventing letter boxing of 4x3 content to play in a 16x9 window, then this should be set to false.
`List<Banner<?>>`	`getCompanionad()` If companion ads are available, they can be listed as an array of banner objects.
`static Comparator<Video<?>>`	`getComparator()` Returns comparator instance for Video objects.
`List<Integer>`	`getDeliverymethod()` List of supported delivery methods (streaming, progressive).
`int`	`getH()` Height of the player in pixels.
`int`	`getLinearity()` Indicates whether the ad impression must be linear, non- linear or can be of any type (field not set).
`int`	`getMaxbitrate()` Maximum bit rate in Kbps.
`int`	`getMaxduration()` Maximum video ad duration in seconds.
`int`	`getMaxextended()` Maximum extended video ad duration, if extension is allowed.
`List<String>`	`getMimes()` Content MIME types supported.
`int`	`getMinbitrate()` Minimum bit rate in Kbps.
`int`	`getMinduration()` Minimum video ad duration in seconds.
`List<Integer>`	`getPlaybackmethod()` List of allowed playback methods.
`int`	`getPos()` Ad Position (see table 6.5).
`static Class<OpenRtbProtobuf.Video>`	`getProtobufClass()` Returns Protobuf class for this struct.
`static com.google.protobuf.Descriptors.Descriptor`	`getProtobufDescriptor()` Returns Protobuf descriptor for this struct.
`static Class<AdExchangeProtobuf>`	`getProtobufProtocolClass()` Returns Protobuf protocol class for this struct.
`static com.google.protobuf.Descriptors.FileDescriptor`	`getProtobufProtocolDescriptor()` Returns Protobuf protocol descriptor for this struct.
`int`	`getProtocol()` Video bid response protocols.
`List<Integer>`	`getProtocols()` Video bid response protocols.
`int`	`getSequence()` If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.
`int`	`getStartdelay()` Indicates the start delay in seconds for preroll, midroll, or postroll ad placement.
`static Class<VideoThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<VideoThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`List<Integer>`	`getVastCompanionType()` Recommended if companion objects are included.
`int`	`getW()` Width of the player in pixels.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultApi()`
`boolean`	`isDefaultBattr()`
`boolean`	`isDefaultBoxingallowed()`
`boolean`	`isDefaultCompanionad()`
`boolean`	`isDefaultDeliverymethod()`
`boolean`	`isDefaultH()`
`boolean`	`isDefaultLinearity()`
`boolean`	`isDefaultMaxbitrate()`
`boolean`	`isDefaultMaxduration()`
`boolean`	`isDefaultMaxextended()`
`boolean`	`isDefaultMimes()`
`boolean`	`isDefaultMinbitrate()`
`boolean`	`isDefaultMinduration()`
`boolean`	`isDefaultPlaybackmethod()`
`boolean`	`isDefaultPos()`
`boolean`	`isDefaultProtocol()`
`boolean`	`isDefaultProtocols()`
`boolean`	`isDefaultSequence()`
`boolean`	`isDefaultStartdelay()`
`boolean`	`isDefaultVastCompanionType()`
`boolean`	`isDefaultW()`
`static Video.NativeImpl`	`nativeImpl(Video<?> instance)` Returns a POJO based on an instance of Video.
`static Video.Builder<VideoAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static Video.Builder<VideoAvro>`	`newAvroBuilder(Video<?> other)` Returns new Avro builder instance based on existing prototype Video.
`static Video.Builder<VideoAvro>`	`newAvroBuilder(VideoAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static Video.Builder<VideoAvro>`	`newAvroBuilder(VideoAvro other)` Returns new Avro builder instance based on existing prototype.
`Video.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static Video.Builder<Video.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static Video.Builder<Video.NativeImpl>`	`newNativeImplBuilder(Video<?> other)` Returns a POJO builder instance based on existing prototype Video.
`static Video.Builder<OpenRtbProtobuf.Video>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static Video.Builder<OpenRtbProtobuf.Video>`	`newProtobufBuilder(OpenRtbProtobuf.Video other)` Returns new Protobuf builder instance based on existing prototype.
`static Video.Builder<OpenRtbProtobuf.Video>`	`newProtobufBuilder(Video<?> other)` Returns new Protobuf builder instance based on existing prototype Video.
`static Video.Builder<VideoThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static Video.Builder<VideoThrift>`	`newThriftBuilder(Video<?> other)` Returns new Thrift builder instance based on existing prototype Video.
`static Video.Builder<VideoThrift>`	`newThriftBuilder(VideoThrift other)` Returns new Thrift builder instance based on existing prototype.
`static Video.Protobuf`	`protobuf(OpenRtbProtobuf.Video wrapped)` Wraps an existing Protobuf message.
`static Video.Protobuf`	`protobuf(Video<?> instance)` Returns a wrapped Protobuf message based on an instance of Video.
`static Video.Thrift`	`thrift(Video<?> instance)` Returns a wrapped Thrift struct based on an instance of Video.
`static Video.Thrift`	`thrift(VideoThrift instance)` Creates a new wrapped Thrift struct copied from an existing instance.

- Method Detail
  - isDefault
```
default boolean isDefault()
```
    True if all fields are set to default values.
  - get
```
T get()
```
    Returns underlying object.
    
    Specified by:
    
    get in interface Supplier<T>
  - newBuilder
```
Video.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getMimes
```
List<String> getMimes()
```
    Content MIME types supported. Popular MIME types include, but are not limited to “video/x-ms- wmv” for Windows Media, and “video/x-flv” for Flash Video.
  - isDefaultMimes
```
boolean isDefaultMimes()
```
  - getMinduration
```
int getMinduration()
```
    Minimum video ad duration in seconds.
  - isDefaultMinduration
```
boolean isDefaultMinduration()
```
  - getMaxduration
```
int getMaxduration()
```
    Maximum video ad duration in seconds.
  - isDefaultMaxduration
```
boolean isDefaultMaxduration()
```
  - getProtocol
```
int getProtocol()
```
    Video bid response protocols. See Table 6.7 Video Bid Response Protocols for a list of possible values. NOTE: Use “protocols” when multiple protocols are supported. Its use is also highly recommended even for one since this “protocol” attribute is likely to be deprecated in a future version. At least one supported protocol must be specified in either the “protocol” or “protocols” attribute.
  - isDefaultProtocol
```
boolean isDefaultProtocol()
```
  - getProtocols
```
List<Integer> getProtocols()
```
    Video bid response protocols. See Table 6.7 Video Bid Response Protocols for a list of possible values. At least one supported protocol must be specified in either the “protocol” or “protocols” attribute.
  - isDefaultProtocols
```
boolean isDefaultProtocols()
```
  - getW
```
int getW()
```
    Width of the player in pixels. This field is not required, but it’s highly recommended that this information be included.
  - isDefaultW
```
boolean isDefaultW()
```
  - getH
```
int getH()
```
    Height of the player in pixels. This field is not required, but it’s highly recommended that this information be included.
  - isDefaultH
```
boolean isDefaultH()
```
  - getStartdelay
```
int getStartdelay()
```
    Indicates the start delay in seconds for preroll, midroll, or postroll ad placement. See Table 6.9 Video Start Delay for generic placement values.
  - isDefaultStartdelay
```
boolean isDefaultStartdelay()
```
  - getLinearity
```
int getLinearity()
```
    Indicates whether the ad impression must be linear, non- linear or can be of any type (field not set). See Table 6.6 Video Linearity for a list of the possible values and recommended bidder interpretation.
  - isDefaultLinearity
```
boolean isDefaultLinearity()
```
  - getSequence
```
int getSequence()
```
    If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.
  - isDefaultSequence
```
boolean isDefaultSequence()
```
  - getBattr
```
List<Integer> getBattr()
```
    Blocked creative attributes. See Table 6.3 Creative Attributes. If blank assume all types are allowed.
  - isDefaultBattr
```
boolean isDefaultBattr()
```
  - getMaxextended
```
int getMaxextended()
```
    Maximum extended video ad duration, if extension is allowed. If blank or 0, extension is not allowed. If -1, extension is allowed, and there is no time limit imposed. If greater than 0, then the value represents the number of seconds of extended play supported beyond the maxduration value.
  - isDefaultMaxextended
```
boolean isDefaultMaxextended()
```
  - getMinbitrate
```
int getMinbitrate()
```
    Minimum bit rate in Kbps. Exchange may set this dynamically, or universally across their set of publishers.
  - isDefaultMinbitrate
```
boolean isDefaultMinbitrate()
```
  - getMaxbitrate
```
int getMaxbitrate()
```
    Maximum bit rate in Kbps. Exchange may set this dynamically, or universally across their set of publishers.
  - isDefaultMaxbitrate
```
boolean isDefaultMaxbitrate()
```
  - getBoxingallowed
```
int getBoxingallowed()
```
    If exchange publisher has rules preventing letter boxing of 4x3 content to play in a 16x9 window, then this should be set to false. Default setting is true, which assumes that boxing of content to fit into a window is allowed. “1” indicates boxing is allowed. “0” indicates it is not allowed.
  - isDefaultBoxingallowed
```
boolean isDefaultBoxingallowed()
```
  - getPlaybackmethod
```
List<Integer> getPlaybackmethod()
```
    List of allowed playback methods. If blank, assume that all are allowed. See Table 6.8 Video Playback Methods for a list of possible values.
  - isDefaultPlaybackmethod
```
boolean isDefaultPlaybackmethod()
```
  - getDeliverymethod
```
List<Integer> getDeliverymethod()
```
    List of supported delivery methods (streaming, progressive). If blank, assume all are supported. See Table 6.12 Content Delivery Methods for a list of possible values.
  - isDefaultDeliverymethod
```
boolean isDefaultDeliverymethod()
```
  - getPos
```
int getPos()
```
    Ad Position (see table 6.5). Default: unknown.
  - isDefaultPos
```
boolean isDefaultPos()
```
  - getCompanionad
```
List<Banner<?>> getCompanionad()
```
    If companion ads are available, they can be listed as an array of banner objects. See Banner Object.
  - isDefaultCompanionad
```
boolean isDefaultCompanionad()
```
  - getApi
```
List<Integer> getApi()
```
    List of supported API frameworks for this impression. (See Table 6.4 API Frameworks). If an API is not explicitly listed it is assumed not to be supported.
  - isDefaultApi
```
boolean isDefaultApi()
```
  - getVastCompanionType
```
List<Integer> getVastCompanionType()
```
    Recommended if companion objects are included. See Table 6.17 VAST Companion Types for a list of possible values.
  - isDefaultVastCompanionType
```
boolean isDefaultVastCompanionType()
```
  - getComparator
```
static Comparator<Video<?>> getComparator()
```
    Returns comparator instance for Video objects.
  - compareTo
```
default int compareTo(Video<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<Video<?>>
  - newNativeImplBuilder
```
static Video.Builder<Video.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static Video.Builder<Video.NativeImpl> newNativeImplBuilder(Video<?> other)
```
    Returns a POJO builder instance based on existing prototype Video.
  - nativeImpl
```
static Video.NativeImpl nativeImpl(Video<?> instance)
```
    Returns a POJO based on an instance of Video.
  - newAvroBuilder
```
static Video.Builder<VideoAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static Video.Builder<VideoAvro> newAvroBuilder(VideoAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static Video.Builder<VideoAvro> newAvroBuilder(VideoAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static Video.Builder<VideoAvro> newAvroBuilder(Video<?> other)
```
    Returns new Avro builder instance based on existing prototype Video.
  - avro
```
static Video.Avro avro(Video<?> instance)
```
    Returns a wrapped Avro record based on an instance of Video.
  - avro
```
static Video.Avro avro(VideoAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<VideoAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static Video.Builder<OpenRtbProtobuf.Video> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static Video.Builder<OpenRtbProtobuf.Video> newProtobufBuilder(OpenRtbProtobuf.Video other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static Video.Builder<OpenRtbProtobuf.Video> newProtobufBuilder(Video<?> other)
```
    Returns new Protobuf builder instance based on existing prototype Video.
  - protobuf
```
static Video.Protobuf protobuf(Video<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of Video.
  - protobuf
```
static Video.Protobuf protobuf(OpenRtbProtobuf.Video wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.Video> getProtobufClass()
```
    Returns Protobuf class for this struct.
  - getProtobufProtocolClass
```
static Class<AdExchangeProtobuf> getProtobufProtocolClass()
```
    Returns Protobuf protocol class for this struct.
  - getProtobufDescriptor
```
static com.google.protobuf.Descriptors.Descriptor getProtobufDescriptor()
```
    Returns Protobuf descriptor for this struct.
  - getProtobufProtocolDescriptor
```
static com.google.protobuf.Descriptors.FileDescriptor getProtobufProtocolDescriptor()
```
    Returns Protobuf protocol descriptor for this struct.
  - newThriftBuilder
```
static Video.Builder<VideoThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static Video.Builder<VideoThrift> newThriftBuilder(VideoThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static Video.Builder<VideoThrift> newThriftBuilder(Video<?> other)
```
    Returns new Thrift builder instance based on existing prototype Video.
  - thrift
```
static Video.Thrift thrift(Video<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of Video.
  - thrift
```
static Video.Thrift thrift(VideoThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<VideoThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<VideoThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface Video<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getMimes

isDefaultMimes

getMinduration

isDefaultMinduration

getMaxduration

isDefaultMaxduration

getProtocol

isDefaultProtocol

getProtocols

isDefaultProtocols

getW

isDefaultW

getH

isDefaultH

getStartdelay

isDefaultStartdelay

getLinearity

isDefaultLinearity

getSequence

isDefaultSequence

getBattr

isDefaultBattr

getMaxextended

isDefaultMaxextended

getMinbitrate

isDefaultMinbitrate

getMaxbitrate

isDefaultMaxbitrate

getBoxingallowed

isDefaultBoxingallowed

getPlaybackmethod

isDefaultPlaybackmethod

getDeliverymethod

isDefaultDeliverymethod

getPos

isDefaultPos

getCompanionad

isDefaultCompanionad

getApi

isDefaultApi

getVastCompanionType

isDefaultVastCompanionType

getComparator

compareTo

newNativeImplBuilder

newNativeImplBuilder

nativeImpl

newAvroBuilder

newAvroBuilder

newAvroBuilder

newAvroBuilder

avro

avro

getAvroClass

getAvroSchema

newProtobufBuilder

newProtobufBuilder

newProtobufBuilder

protobuf

protobuf

getProtobufClass

getProtobufProtocolClass

getProtobufDescriptor

getProtobufProtocolDescriptor

newThriftBuilder

newThriftBuilder

newThriftBuilder

thrift

thrift

getThriftClass

getThriftMetadataMap