Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
57 lines (41 sloc) 1.38 KB

API

Interface props {
    videoId: String,
    className?: String = 'vimeo',
    onReady?(data?: Object) => Void,
    onCuechange?(data?: Object) => Void,
    onError?(data?: Object) => Void,
    onFinish?(data?: Object) => Void,
    onLoadProgress?(data?: Object) => Void,
    onPause?(data?: Object) => Void,
    onPlay?(data?: Object) => Void,
    onPlayProgress?(data?: Object) => Void,
    onSeek?(data?: Object) => Void
};

videoId: String

The Vimeo video ID

className: String

className applied to wrapping div

onReady?(data: Object) => Void

Called when video has loaded and is ready to play. Other event functions will not be called before this one other than onError

onCuechange?(data: Object) => Void

Called when the player que changes.

onError?(data: Object) => Void

Called in the event that there is an error. If no error handler provided, the error will be thrown.

onFinish?(data: Object) => Void

Called when video completes

onLoadProgress?(data: Object) => Void

Called when part of video has loaded

onPause?(data: Object) => Void

Called when video is paused

onPlay?(data: Object) => Void

Called when video is played

onPlayProgress?(data: Object) => Void

Called when video play has progressed

onSeek?(data: Object) => Void

Called when user seeks ahead in video

Interactive api (play/pause actions, seek to n, etc..) to come in future versions

Something went wrong with that request. Please try again.