VideoEvents

java.lang.Object
- com.iab.omid.library.adsession.video.VideoEvents

```
public final class VideoEvents
extends java.lang.Object
```
This provides a complete list of native video events supported by OMID. Using this event API assumes the video player is fully responsible for communicating all video events at the appropriate times. Only one video events implementation can be associated with the ad session and any attempt to create multiple instances will result in an exception.
Created by Natasha Garner on 10/09/2017.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`adUserInteraction(InteractionType interactionType)` Notify all video listeners that the user has performed an ad interaction.
`void`	`bufferFinish()` Notify all video listeners that buffering has finished and video playback has resumed.
`void`	`bufferStart()` Notify all video listeners that video playback has stopped and started buffering.
`void`	`complete()` Notify all video listeners that video playback is complete.
`static VideoEvents`	`createVideoEvents(AdSession adSession)` Create video events instance for the associated ad session.
`void`	`firstQuartile()` Notify all video listeners that video playback has reached the first quartile.
`void`	`loaded(VastProperties vastProperties)` Notify all video listeners that video content has been loaded and ready to start playing.
`void`	`midpoint()` Notify all video listeners that video playback has reached the midpoint.
`void`	`pause()` Notify all video listeners that video playback has paused after a user interaction.
`void`	`playerStateChange(PlayerState playerState)` Notify all video listeners that video player state has changed.
`void`	`resume()` Notify all video listeners that video playback has resumed (after being paused) after a user interaction.
`void`	`skipped()` Notify all video listeners that video playback has stopped as a user skip interaction.
`void`	`start(float duration, float videoPlayerVolume)` Notify all video listeners that video content has started playing.
`void`	`thirdQuartile()` Notify all video listeners that video playback has reached the third quartile.
`void`	`volumeChange(float videoPlayerVolume)` Notify all video listeners that the video player volume has changed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createVideoEvents
```
public static VideoEvents createVideoEvents(AdSession adSession)
```
    Create video events instance for the associated ad session. Any attempt to create a video events instance will fail if the supplied ad session has already started.
    
    Parameters:
    
    adSession - associated with the ad events.
    
    Returns:
    
    new video events instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the supplied ad session is null.
    
    java.lang.IllegalStateException - if a video events instance has already been registered with the ad session.
    
    java.lang.IllegalStateException - if a video events instance has been created after the ad session has started.
    
    See Also:
    
    AdSession
  - loaded
```
public void loaded(VastProperties vastProperties)
```
    Notify all video listeners that video content has been loaded and ready to start playing.
    
    Parameters:
    
    vastProperties - containing static information about the video placement.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the supplied VAST properties is null.
    
    java.lang.IllegalStateException - if the ad session has finished.
    
    See Also:
    
    VastProperties
  - start
```
public void start(float duration,
                  float videoPlayerVolume)
```
    Notify all video listeners that video content has started playing.
    
    Parameters:
    
    duration - of the selected video media (in seconds).
    
    videoPlayerVolume - from the native video player with a range between 0 and 1.
    
    Throws:
    
    java.lang.IllegalArgumentException - if an invalid duration or videoPlayerVolume has been supplied.
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
  - firstQuartile
```
public void firstQuartile()
```
    Notify all video listeners that video playback has reached the first quartile.
    
    Throws:
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
  - midpoint
```
public void midpoint()
```
    Notify all video listeners that video playback has reached the midpoint.
    
    Throws:
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
  - thirdQuartile
```
public void thirdQuartile()
```
    Notify all video listeners that video playback has reached the third quartile.
    
    Throws:
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
  - complete
```
public void complete()
```
    Notify all video listeners that video playback is complete.
    
    Throws:
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
  - pause
```
public void pause()
```
    Notify all video listeners that video playback has paused after a user interaction.
    
    Throws:
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
  - resume
```
public void resume()
```
    Notify all video listeners that video playback has resumed (after being paused) after a user interaction.
    
    Throws:
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
  - bufferStart
```
public void bufferStart()
```
    Notify all video listeners that video playback has stopped and started buffering.
    
    Throws:
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
  - bufferFinish
```
public void bufferFinish()
```
    Notify all video listeners that buffering has finished and video playback has resumed.
    
    Throws:
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
  - skipped
```
public void skipped()
```
    Notify all video listeners that video playback has stopped as a user skip interaction. Once skipped video it should not be possible for the video to resume playing content.
    
    Throws:
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
  - volumeChange
```
public void volumeChange(float videoPlayerVolume)
```
    Notify all video listeners that the video player volume has changed.
    
    Parameters:
    
    videoPlayerVolume - from the native video player with a range between 0 and 1.
    
    Throws:
    
    java.lang.IllegalArgumentException - if an invalid videoPlayerVolume has been supplied.
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
  - playerStateChange
```
public void playerStateChange(PlayerState playerState)
```
    Notify all video listeners that video player state has changed. See PlayerState for list of supported states.
    
    Parameters:
    
    playerState - to signal the latest video player state
    
    Throws:
    
    java.lang.IllegalArgumentException - if the supplied player state is null.
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
    
    See Also:
    
    PlayerState
  - adUserInteraction
```
public void adUserInteraction(InteractionType interactionType)
```
    Notify all video listeners that the user has performed an ad interaction. See InteractionType for list of supported types.
    
    Parameters:
    
    interactionType - to signal the latest user integration
    
    Throws:
    
    java.lang.IllegalArgumentException - if the supplied interaction type is null.
    
    java.lang.IllegalStateException - if the ad session has not been started or has finished.
    
    See Also:
    
    InteractionType

Class VideoEvents

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createVideoEvents

loaded

start

firstQuartile

midpoint

thirdQuartile

complete

pause

resume

bufferStart

bufferFinish

skipped

volumeChange

playerStateChange

adUserInteraction