:orphan:

.. index:: pair: group; Test API to operate the media files
.. _doxid-group__tapi__media__file:

Test API to operate the media files
===================================

.. toctree::
	:hidden:

	struct_tapi_media_file.rst
	struct_tapi_media_file_metadata.rst

Overview
~~~~~~~~

Functions for convenient work with the media files on local storage. :ref:`More...<details-group__tapi__media__file>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// typedefs

	typedef struct :ref:`tapi_media_file_metadata<doxid-structtapi__media__file__metadata>` :ref:`tapi_media_file_metadata<doxid-group__tapi__media__file_1ga8250f8beb9554da7872ad7d1c17b1d01>`;
	typedef struct :ref:`tapi_media_file<doxid-structtapi__media__file>` :ref:`tapi_media_file<doxid-group__tapi__media__file_1gaa8ab18f5b23bb6d75a201c2727a60192>`;

	// structs

	struct :ref:`tapi_media_file<doxid-structtapi__media__file>`;
	struct :ref:`tapi_media_file_metadata<doxid-structtapi__media__file__metadata>`;

	// global functions

	static const char* :ref:`tapi_media_file_get_metadata_title<doxid-group__tapi__media__file_1gabafcf73c2e638c6f264670eca3f84eaf>`(const :ref:`tapi_media_file_metadata<doxid-structtapi__media__file__metadata>`* metadata);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_media_file_get_from_local<doxid-group__tapi__media__file_1ga9b2f032a7aa34e49691a12cff5180a61>`(const :ref:`tapi_local_file<doxid-structtapi__local__file>`* local_file, :ref:`tapi_media_file<doxid-structtapi__media__file>`** media_file);
	void :ref:`tapi_media_file_free<doxid-group__tapi__media__file_1ga0360c7c6ee440b59c2353f680bc24cfe>`(:ref:`tapi_media_file<doxid-structtapi__media__file>`* media_file);

.. _details-group__tapi__media__file:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Functions for convenient work with the media files on local storage.

Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved.

Typedefs
--------

.. index:: pair: typedef; tapi_media_file_metadata
.. _doxid-group__tapi__media__file_1ga8250f8beb9554da7872ad7d1c17b1d01:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct :ref:`tapi_media_file_metadata<doxid-structtapi__media__file__metadata>` tapi_media_file_metadata

Metadata of media file.

.. index:: pair: typedef; tapi_media_file
.. _doxid-group__tapi__media__file_1gaa8ab18f5b23bb6d75a201c2727a60192:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	typedef struct :ref:`tapi_media_file<doxid-structtapi__media__file>` tapi_media_file

Media file object.

Global Functions
----------------

.. index:: pair: function; tapi_media_file_get_metadata_title
.. _doxid-group__tapi__media__file_1gabafcf73c2e638c6f264670eca3f84eaf:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static const char* tapi_media_file_get_metadata_title(const :ref:`tapi_media_file_metadata<doxid-structtapi__media__file__metadata>`* metadata)

Get title from file metadata.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- metadata

		- File metadata.



.. rubric:: Returns:

Title of media file.

.. index:: pair: function; tapi_media_file_get_from_local
.. _doxid-group__tapi__media__file_1ga9b2f032a7aa34e49691a12cff5180a61:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_media_file_get_from_local(const :ref:`tapi_local_file<doxid-structtapi__local__file>`* local_file, :ref:`tapi_media_file<doxid-structtapi__media__file>`** media_file)

Convert local file to media file and extract it metadata from /local/fs configugator tree. Media file with it resources should be released with ``tapi_media_file_release`` when it is no longer needed.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- local_file

		- Local file

	*
		- media_file

		- Media file.



.. rubric:: Returns:

Status code.



.. rubric:: See also:

tapi_media_file_release

.. index:: pair: function; tapi_media_file_free
.. _doxid-group__tapi__media__file_1ga0360c7c6ee440b59c2353f680bc24cfe:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void tapi_media_file_free(:ref:`tapi_media_file<doxid-structtapi__media__file>`* media_file)

Release media file that was got with ``tapi_media_file_get_from_local``.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- media_file

		- Media file.



.. rubric:: See also:

:ref:`tapi_media_file_get_from_local <doxid-group__tapi__media__file_1ga9b2f032a7aa34e49691a12cff5180a61>`