cue_points
cue_points:Array
API Versions: V2
Parent: outputs
Valid Values: An array of hashes with cue point settings
Compatible Job Types: vod
Description:
Zencoder supports adding event and navigation cue points to VP6 Flash Video (FLV) files. Cue points are embedded in the FLV stream and FLV metadata packet when you encode the FLV file.
There are two cue point types: "navigation" and "event". Navigation cue points can be used to let users seek to a specified part of a video file. Navigation cue points create a keyframe at the specified cue point location, so you can use code to move a video player’s playhead to that location. You can set particular points in an FLV file where you might want users to seek. For example, your video might have multiple chapters or segments, and you can control the video by embedding navigation cue points in the video file.
Event cue points can be used to perform actions in a SWF video player that are triggered at specified points during FLV playback.
For more information, see this Adobe article about cue points.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"cue_points": [
{
"type": "navigation",
"time": 30.4,
"name": "My Cue Point",
"data": {
"mykey": "myvalue"
}
}
]
}
]
}
type
type:String
API Versions: V2
Parent: outputs
Valid Values: navigation or event
Compatible Job Types: vod
Description:
A cue_point type: either "navigation" or "event".
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"cue_points": [
{
"type": "navigation",
"time": 30.4,
"name": "My Cue Point",
"data": {
"mykey": "myvalue"
}
}
]
}
]
}
See Also: cue_points, time, name, and data
time
time:Float
API Versions: V2
Parent: outputs
Valid Values: A positive float
Compatible Job Types: vod
Description:
The time for a cue_point, in seconds.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"cue_points": [
{
"type": "navigation",
"time": 30.4,
"name": "My Cue Point",
"data": {
"mykey": "myvalue"
}
}
]
}
]
}
See Also: cue_points, type, name, and data
name
name:String
API Versions: V2
Parent: outputs
Compatible Job Types: vod
Description:
A name for a cue_point.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"cue_points": [
{
"type": "navigation",
"time": 30.4,
"name": "My Cue Point",
"data": {
"mykey": "myvalue"
}
}
]
}
]
}
See Also: cue_points, time, type, and data
data
data:Hash
API Versions: V2
Parent: outputs
Valid Values: key/value pairs
Compatible Job Types: vod
Description:
Data for a cue_point, as a hash of key/value pairs.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"cue_points": [
{
"type": "navigation",
"time": 30.4,
"name": "My Cue Point",
"data": {
"mykey": "myvalue"
}
}
]
}
]
}
See Also: cue_points, time, name, and type