iota.media

Description

This module provides functionalities to display videos and images on notebooks.

• IotaVideo

  • filepath

  • display

• IotaImage

  • filepath

  • display

class IotaVideo

iota.media.IotaVideo(filepath)

Iota Video class object. This object can be created based on an existing video file or returned by the iota methods that allow to generate a videos (see for example iota.render.create_video and iota.render.Scene.create_video)

Parameters

• filepath : (str) filepath and name of the video file

Example

Creating an IotaVideo object given a the path to a video file

my_video = iota.media.IotaVideo(filepath= 'C:/Users/Stephen/MyVideo/my_video.mp4')

Attributes

IotaVideo.filepath

Get the path and the name of the video file

Returns

• A string with path and name of the video file

Example

Getting the path and the name of the IotaVideo object

video_file = my_video.filepath
print(video_file)

Methods

IotaVideo.display(width, height)

Display an IotaVideo on the working notebook

Parameters

• width : (int) width of the video display in pixels (Default: None)

• height : (int) height of the video display in pixels (Default: None)

Example

Displaying an IotaVideo on the working notebook with original dimensions of the video

my_video.display()

Displaying an IotaVideo on the working notebook with width equal to 600 pixels and keeping the original aspect ratio of the video

my_video.display(width=600)

Displaying an IotaVideo on the working notebook with width equal to 800 pixels and height equal to 600 pixels

my_video.display(width=800, height=600)

class IotaImage

iota.media.IotaImage(filepath)

Iota Image class object. This object can be created based on an existing image file or returned by the iota methods that allow to generate a images (see for example iota.render.create_screenshots and iota.render.Scene.create_screenshots)

Parameters

• filepath : (str) filepath and name of the image file

Example

Creating an IotaImage object given a the path to a image file

my_image = iota.media.IotaImage(filepath= 'C:/Users/Stephen/MyImages/my_image.png')

Attributes

IotaImage.filepath

Get the path and the name of the image file

Returns

• A string with path and name of the video file

Example

Getting the path and the name of the IotaImage object

image_file = my_image.filepath
print(image_file)

Methods

IotaImage.display(width, height)

Display an IotaImage on the working notebook

Parameters

• width : (int) width of the image display in pixels (Default: None)

• height : (int) height of the image display in pixels (Default: None)

Example

Displaying an IotaImage on the working notebook with original dimensions of the image

my_image.display()

Displaying an IotaImage on the working notebook with width equal to 600 pixels and keeping the original aspect ratio of the image

my_image.display(width=600)

Displaying an IotaImage on the working notebook with width equal to 800 pixels and height equal to 600 pixels

my_image.display(width=800, height=600)