VideoFrameAPI¶
- class VideoFrameAPI[source]¶
Bases:
supervisely.api.module_api.ModuleApi
Frame
for a single video.VideoFrameAPI
object is immutable.Methods
_convert_info_to_json
Download frames with given indexes from Dataset in Binary format.
Download Image for frame with given index from given video ID in numpy format (RGB).
Download frames with given indexes from given video ID in numpy format(RGB).
download_nps_generator
Downloads frame on the given path for frame with given index from given Video ID.
Downloads frames to given paths for frames with given indexes from given Video ID.
Checks if an entity with the given parent_id and name exists
Generates a free name for an entity with the given parent_id and name.
Get information about an entity by its ID from the Supervisely server.
Get information about an entity by its name from the Supervisely server.
Get list of entities in parent entity with given parent ID.
Get list of all or limited quantity entities from the Supervisely server.
This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved
Get the list of items for a given page number.
Yields list of images in dataset asynchronously page by page.
Get list of all class field names.
Get string name of NamedTuple.
Attributes
MAX_WAIT_ATTEMPTS
Maximum number of attempts that will be made to wait for a certain condition to be met.
WAIT_ATTEMPT_TIMEOUT_SEC
Number of seconds for intervals between attempts.
-
download_bytes(video_id, frame_indexes, progress_cb=
None
)[source]¶ Download frames with given indexes from Dataset in Binary format.
- Parameters
- Returns
List of Images in binary format
- Return type
List[bytes]
- Usage example
import supervisely as sly os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() video_id = 213542 frame_indexes = [1,2,3,4,5,10,11,12,13,14,15] frames_bytes = api.video.frame.download_bytes(video_id=video_id, frame_indexes=frame_indexes) print(frames_bytes) # Output: [b'ÿØÿàJFIF\...]
- download_np(video_id, frame_index)[source]¶
Download Image for frame with given index from given video ID in numpy format (RGB).
- Parameters
- Returns
Image in RGB numpy matrix format
- Return type
np.ndarray
- Usage example
import supervisely as sly os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() video_id = 198703211 frame_idx = 5 image_np = api.video.frame.download_np(video_id, frame_idx)
-
download_nps(video_id, frame_indexes, progress_cb=
None
, keep_alpha=False
)[source]¶ Download frames with given indexes from given video ID in numpy format(RGB).
- Parameters
- Returns
List of Images in RGB numpy matrix format
- Return type
List[np.ndarray]
- Usage example
import supervisely as sly os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() video_id = 198703211 frame_indexes = [1,2,3,4,5,10,11,12,13,14,15] images_np = api.video.frame.download_nps(video_id, frame_indexes)
- download_path(video_id, frame_index, path)[source]¶
Downloads frame on the given path for frame with given index from given Video ID.
- Parameters
- Returns
None
- Return type
NoneType
- Usage example
import supervisely as sly os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() video_id = 198703211 frame_idx = 5 save_path = '/home/admin/Downloads/frames/result.png' api.video.frame.download_path(video_id, frame_idx, save_path)
-
download_paths(video_id, frame_indexes, paths, progress_cb=
None
)[source]¶ Downloads frames to given paths for frames with given indexes from given Video ID.
- Parameters
- Returns
None
- Return type
NoneType
- Usage example
import supervisely as sly os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() video_id = 198703211 frame_indexes = [1,2,3,4,5,10,11,12,13,14,15] save_paths = [f"/home/admin/projects/video_project/frames/{idx}.png" for idx in frame_indexes] api.video.frame.download_paths(video_id, frame_indexes, save_paths)
- exists(parent_id, name)¶
Checks if an entity with the given parent_id and name exists
- Parameters
- Returns
Returns True if entity exists, and False if not
- Return type
- Usage example
import supervisely as sly # You can connect to API directly address = 'https://app.supervise.ly/' token = 'Your Supervisely API Token' api = sly.Api(address, token) # Or you can use API from environment os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() name = "IMG_0315.jpeg" dataset_id = 55832 exists = api.image.exists(dataset_id, name) print(exists) # True
- get_free_name(parent_id, name)¶
Generates a free name for an entity with the given parent_id and name. Adds an increasing suffix to original name until a unique name is found.
- Parameters
- Returns
Returns free name.
- Return type
- Usage example
import supervisely as sly # You can connect to API directly address = 'https://app.supervise.ly/' token = 'Your Supervisely API Token' api = sly.Api(address, token) # Or you can use API from environment os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() name = "IMG_0315.jpeg" dataset_id = 55832 free_name = api.image.get_free_name(dataset_id, name) print(free_name) # IMG_0315_001.jpeg
- get_info_by_id(id)¶
Get information about an entity by its ID from the Supervisely server.
- Parameters
- id : int
ID of the entity.
-
get_info_by_name(parent_id, name, fields=
[]
)¶ Get information about an entity by its name from the Supervisely server.
- Parameters
- Usage example
import supervisely as sly # You can connect to API directly address = 'https://app.supervise.ly/' token = 'Your Supervisely API Token' api = sly.Api(address, token) # Or you can use API from environment os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() dataset_id = 55832 name = "IMG_0315.jpeg" info = api.image.get_info_by_name(dataset_id, name) print(info) # Output: ImageInfo(id=19369643, name='IMG_0315.jpeg', ...)
-
get_list(parent_id, filters=
None
)¶ Get list of entities in parent entity with given parent ID.
- Parameters
- Usage example
import supervisely as sly # You can connect to API directly address = 'https://app.supervise.ly/' token = 'Your Supervisely API Token' api = sly.Api(address, token) # Or you can use API from environment os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() dataset_id = 55832 images = api.image.get_list(dataset_id) print(images) # Output: [ ImageInfo(id=19369642, ...) ImageInfo(id=19369643, ...) ImageInfo(id=19369644, ...) ]
-
get_list_all_pages(method, data, progress_cb=
None
, convert_json_info_cb=None
, limit=None
, return_first_response=False
)¶ Get list of all or limited quantity entities from the Supervisely server.
- Parameters
- method : str
Request method name
- data : dict
Dictionary with request body info
- progress_cb : Progress, optional
Function for tracking download progress.
- convert_json_info_cb : Callable, optional
Function for convert json info
- limit : int, optional
Number of entity to retrieve
- return_first_response : bool, optional
Specify if return first response
-
get_list_all_pages_generator(method, data, progress_cb=
None
, convert_json_info_cb=None
, limit=None
, return_first_response=False
)¶ This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved
- Parameters
- method : str
Request method name
- data : dict
Dictionary with request body info
- progress_cb : Progress, optional
Function for tracking download progress.
- convert_json_info_cb : Callable, optional
Function for convert json info
- limit : int, optional
Number of entity to retrieve
- return_first_response : bool, optional
Specify if return first response
- async get_list_idx_page_async(method, data)¶
Get the list of items for a given page number. Page number is specified in the data dictionary.
-
async get_list_page_generator_async(method, data, pages_count=
None
, semaphore=None
)¶ Yields list of images in dataset asynchronously page by page.
- Parameters
- method : str
Method to call for listing items.
- data : dict
Data to pass to the API method.
- pages_count : int, optional
Preferred number of pages to retrieve if used with a
per_page
limit. Will be automatically adjusted if thepagesCount
differs from the requested number.- semaphore :
asyncio.Semaphore
, optional Semaphore for limiting the number of simultaneous requests.
- kwargs
Additional arguments.
- Returns
List of images in dataset.
- Return type
AsyncGenerator[List[ImageInfo]]
- Usage example
import supervisely as sly import asyncio os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() method = 'images.list' data = { 'datasetId': 123456 } loop = sly.utils.get_or_create_event_loop() images = loop.run_until_complete(api.image.get_list_generator_async(method, data))
- static info_sequence()¶
Get list of all class field names.
- static info_tuple_name()¶
Get string name of NamedTuple.
-
download_bytes(video_id, frame_indexes, progress_cb=