Documentation

Create and manage your effect profiles and their processes through simple API calls. All that from the comfort of your C# scripts.

It is simple, fast and bellow you can see exactly how to do it.

Fork me on GitHub
  • create
    Create a new effect profile.
    ziggeo.effectProfiles().create(Dictionary<string, string> arguments)
    
    1. key Effect profile key.
    2. title Effect profile title.
    3. default_effect Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect
    This method returns JSON
  • index
    Get list of effect profiles.
    ziggeo.effectProfiles().index(Dictionary<string, string> arguments)
    
    1. limit Limit the number of returned effect profiles. Can be set up to 100.
    2. skip Skip the first [n] entries.
    3. reverse Reverse the order in which effect profiles are returned.
    This method returns JSON
  • get
    Get a single effect profile
    ziggeo.effectProfiles().get(string token_or_key)
    
    This method returns JSON
  • delete
    Delete the effect profile
    ziggeo.effectProfiles().delete(string token_or_key)
    
  • update
    Updates an effect profile.
    ziggeo.effectProfiles().update(string token_or_key, Dictionary<string, string> arguments)
    
    1. default_effect Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect
    This method returns JSON
  • index
    Return all processes associated with a effect profile
    ziggeo.effectProfileProcess().index(string effect_token_or_key, Dictionary<string, string> arguments)
    
    1. states Filter streams by state
    This method returns JSON
  • get
    Get a single process
    ziggeo.effectProfileProcess().get(string effect_token_or_key, string token_or_key)
    
    This method returns JSON
  • delete
    Delete the process
    ziggeo.effectProfileProcess().delete(string effect_token_or_key, string token_or_key)
    
  • create_filter_process
    Create a new filter effect process
    ziggeo.effectProfileProcess().create_filter_process(string effect_token_or_key, Dictionary<string, string> arguments)
    
    1. effect Effect to be applied in the process
    This method returns JSON
  • create_watermark_process
    Attaches an image to a new stream
    ziggeo.effectProfileProcess().create_watermark_process(string effect_token_or_key, Dictionary<string, string> arguments, string file)
    
    1. file Image file to be attached
    2. vertical_position Specify the vertical position of your watermark (a value between 0.0 and 1.0)
    3. horizontal_position Specify the horizontal position of your watermark (a value between 0.0 and 1.0)
    4. video_scale Specify the image scale of your watermark (a value between 0.0 and 1.0)
    This method returns JSON
  • edit_watermark_process
    Edits an existing watermark process.
    ziggeo.effectProfileProcess().edit_watermark_process(string effect_token_or_key, string token_or_key, Dictionary<string, string> arguments, string file)
    
    1. file Image file to be attached
    2. vertical_position Specify the vertical position of your watermark (a value between 0.0 and 1.0)
    3. horizontal_position Specify the horizontal position of your watermark (a value between 0.0 and 1.0)
    4. video_scale Specify the image scale of your watermark (a value between 0.0 and 1.0)
    This method returns JSON