Documentation

Every video has multiple streams. From original, to default and any other streams that have been created based on your setup.

Here you will see the way to work with video streams through your PHP API calls.

Fork me on GitHub
  • index
    Return all streams associated with a video
    $ziggeo->streams()->index($video_token_or_key, $arguments = array())
    
    1. states Filter streams by state
    This method returns JSON
    [
    	{
    	"volatile":false,
    	"token":"d751140b4e1cf0a243f32092f6110296",
    	"key":null,
    	"creation_type":5,
    	"state":5,
    	"streamable":2,
    	"video_type":"mp4",
    	"video_sub_type":"other",
    	"image_size":0,
    	"video_size":36078,
    	"video_width":640,
    	"video_height":360,
    	"duration":1,
    	"has_video":true,
    	"has_image":true,
    	"submission_date":1390257799,
    	"type":"ApiVideoStream",
    	"created":1390257799,
    	"owned":true,
    	"creation_type_string":"SERVER_UPLOAD",
    	"streamable_string":"DEGRADED",
    	"state_string":"READY"
    }]
    
  • get
    Get a single stream
    $ziggeo->streams()->get($video_token_or_key, $token_or_key)
    
    This method returns JSON
    {
    	"volatile":false,
    	"token":"d751140b4e1cf0a243f32092f6110296",
    	"key":null,
    	"creation_type":5,
    	"state":5,
    	"streamable":2,
    	"video_type":"mp4",
    	"video_sub_type":"other",
    	"image_size":0,
    	"video_size":36078,
    	"video_width":640,
    	"video_height":360,
    	"duration":1,
    	"has_video":true,
    	"has_image":true,
    	"submission_date":1390257799,
    	"type":"ApiVideoStream",
    	"created":1390257799,
    	"owned":true,
    	"creation_type_string":"SERVER_UPLOAD",
    	"streamable_string":"DEGRADED",
    	"state_string":"READY"
    }
    
  • download_video
    Download the video data associated with the stream
    $ziggeo->streams()->download_video($video_token_or_key, $token_or_key)
    
    This method returns DATA
  • download_image
    Download the image data associated with the stream
    $ziggeo->streams()->download_image($video_token_or_key, $token_or_key)
    
    This method returns DATA
  • push_to_service
    Push a stream to a provided push service.
    $ziggeo->streams()->push_to_service($video_token_or_key, $token_or_key, $arguments = array())
    
    1. pushservicetoken Push Services's token (from the Push Services configured for the app)
    This method returns JSON
  • delete
    Delete the stream
    $ziggeo->streams()->delete($video_token_or_key, $token_or_key)
    
  • create
    Create a new stream
    $ziggeo->streams()->create($video_token_or_key, $arguments = array())
    
    1. file Video file to be uploaded
    This method returns JSON
    {
    	"volatile":false,
    	"token":"d751140b4e1cf0a243f32092f6110296",
    	"key":null,
    	"creation_type":5,
    	"state":5,
    	"streamable":2,
    	"video_type":"mp4",
    	"video_sub_type":"other",
    	"image_size":0,
    	"video_size":36078,
    	"video_width":640,
    	"video_height":360,
    	"duration":1,
    	"has_video":true,
    	"has_image":true,
    	"submission_date":1390257799,
    	"type":"ApiVideoStream",
    	"created":1390257799,
    	"owned":true,
    	"creation_type_string":"SERVER_UPLOAD",
    	"streamable_string":"DEGRADED",
    	"state_string":"READY"
    }
    
  • attach_image
    Attaches an image to a new stream
    $ziggeo->streams()->attach_image($video_token_or_key, $token_or_key, $arguments = array())
    
    1. file Image file to be attached
    This method returns JSON
  • attach_video
    Attaches a video to a new stream
    $ziggeo->streams()->attach_video($video_token_or_key, $token_or_key, $arguments = array())
    
    1. file Video file to be attached
    This method returns JSON
  • attach_subtitle
    Attaches a subtitle to the stream.
    $ziggeo->streams()->attach_subtitle($video_token_or_key, $token_or_key, $arguments = array())
    
    1. lang Subtitle language
    2. label Subtitle reference
    3. data Actual subtitle
    This method returns JSON
  • bind
    Closes and submits the stream
    $ziggeo->streams()->bind($video_token_or_key, $token_or_key, $arguments = array())
    
    This method returns JSON