Working with effect profiles from Node SDK
Node SDK offers you a way to handle effect profiles from the backend of your system.
Create and manage your effect profiles and their processes through simple API calls. All that from the comfort of your NodeJS scripts.
It is simple, fast and bellow you can see exactly how to do it.
NodeJS SDK Effect Profiles Methods
- create Create a new effect profile.
ZiggeoSdk.EffectProfiles.create(arguments, [callbacks])
- key Effect profile key.
- title Effect profile title.
- 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.
ZiggeoSdk.EffectProfiles.index(arguments, [callbacks])
- limit Limit the number of returned effect profiles. Can be set up to 100.
- skip Skip the first [n] entries.
- reverse Reverse the order in which effect profiles are returned.
This method returns JSON - get Get a single effect profile
ZiggeoSdk.EffectProfiles.get(token_or_key, [callbacks])
This method returns JSON - delete Delete the effect profile
ZiggeoSdk.EffectProfiles.destroy(token_or_key, [callbacks])
- update Updates an effect profile.
ZiggeoSdk.EffectProfiles.update(token_or_key, arguments, [callbacks])
- 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
NodeJS SDK Effect Profile Processes Methods
- index Return all processes associated with a effect profile
ZiggeoSdk.EffectProfileProcess.index(effect_token_or_key, arguments, [callbacks])
- states Filter streams by state
This method returns JSON - get Get a single process
ZiggeoSdk.EffectProfileProcess.get(effect_token_or_key, token_or_key, [callbacks])
This method returns JSON - delete Delete the process
ZiggeoSdk.EffectProfileProcess.destroy(effect_token_or_key, token_or_key, [callbacks])
- create_filter_process Create a new filter effect process
ZiggeoSdk.EffectProfileProcess.create_filter_process(effect_token_or_key, arguments, [callbacks])
- effect Effect to be applied in the process
This method returns JSON - create_watermark_process Attaches an image to a new stream
ZiggeoSdk.EffectProfileProcess.create_watermark_process(effect_token_or_key, arguments, [callbacks])
- file Image file to be attached
- vertical_position Specify the vertical position of your watermark (a value between 0.0 and 1.0)
- horizontal_position Specify the horizontal position of your watermark (a value between 0.0 and 1.0)
- 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.
ZiggeoSdk.EffectProfileProcess.edit_watermark_process(effect_token_or_key, token_or_key, arguments, [callbacks])
- file Image file to be attached
- vertical_position Specify the vertical position of your watermark (a value between 0.0 and 1.0)
- horizontal_position Specify the horizontal position of your watermark (a value between 0.0 and 1.0)
- video_scale Specify the image scale of your watermark (a value between 0.0 and 1.0)
This method returns JSON