Class documentation (picovico.components)

Submodules

picovico.components.music module

class picovico.components.music.PicovicoMusic(request_obj)

Picovico-SDK: Music component class.

Parameters:request_obj (PicovicoRequest) – instance of PicovicoRequest.
Raises:AssertionError
upload_url(url, preview)

upload music url and music preview

Parameters:
  • url (str) – URL of music.
  • preview (str) – preview url of music.
all(*args, **kwargs)

Fetch all.

delete(*args, **kwargs)

Remove specific.

Parameters:id (str) – id to be removed.
get_free(*args, **kwargs)

View Picovico free components.

one(*args, **kwargs)

Fetch one with specific id.

Parameters:id (str) – id to fetch.
upload_file(*args, **kwargs)

Upload file.

Parameters:
  • filname (str) – path to file.
  • data_headers (dict) – Optional Any additional headers.

picovico.components.photo module

class picovico.components.photo.PicovicoPhoto(request_obj)

Picovico-SDK: Photo Component class.

Parameters:request_obj (PicovicoRequest) – instance of PicovicoRequest.
Raises:AssertionError
upload_url(url, thumbnail)

upload photo url and thubnail.

Parameters:
  • url (str) – Photo URL to upload.
  • thumbnail (str) – Thumbnail URL to upload.
all(*args, **kwargs)

Fetch all.

delete(*args, **kwargs)

Remove specific.

Parameters:id (str) – id to be removed.
one(*args, **kwargs)

Fetch one with specific id.

Parameters:id (str) – id to fetch.
upload_file(*args, **kwargs)

Upload file.

Parameters:
  • filname (str) – path to file.
  • data_headers (dict) – Optional Any additional headers.

picovico.components.style module

class picovico.components.style.PicovicoStyle(request_obj)

Picovico-SDK: Style Component class.

Parameters:request_obj (PicovicoRequest) – instance of PicovicoRequest.
Raises:AssertionError
all(*args, **kwargs)

Fetch all.

delete(*args, **kwargs)

Remove specific.

Parameters:id (str) – id to be removed.
get_free(*args, **kwargs)

View Picovico free components.

one(*args, **kwargs)

Fetch one with specific id.

Parameters:id (str) – id to fetch.

picovico.components.video module

class picovico.components.video.PicovicoVideo(request_obj)

Picovico-SDK: Picovico Video Component class.

Parameters:request_obj (PicovicoRequest) – instance of PicovicoRequest.
Raises:AssertionError
preview(*args, **kwargs)

Picovico: Make a preview request for the project. 144p video preview is available for the style. Rendering state of the video will not be changed.

create(*args, **kwargs)

Picovico: Sends the actual rendering request to rendering engine

duplicate(*args, **kwargs)

Picovico: Duplicates any video and saves it to the new draft or overrides if any exists.

save(*args, **kwargs)

Save video with vdd data.

Parameters:video_id (str) – Video identifier to be saved.
all(*args, **kwargs)

Fetch all.

delete(*args, **kwargs)

Remove specific.

Parameters:id (str) – id to be removed.
one(*args, **kwargs)

Fetch one with specific id.

Parameters:id (str) – id to fetch.