mme_mediacopier_get_status()

Get the status of a media copy or ripping operation

Synopsis:

#include <mme/mme.h>

int mme_mediacopier_get_status( mme_hdl_t *hdl,
                                mme_copy_status_t *copy_status);

Arguments:

hdl
An MME connection handle.
msg
A pointer to the structure mme_copy_status_t that is filled in by the function. See mme_copy_status_t below.

Library:

mme

Description:

The function mme_mediacopier_get_status() gets the status of a media copying or ripping operation. The status information is placed in a structure mme_copy_status_t.

mme_copy_status_t

typedef struct _mme_copy_status {
   uint64_t             cqid;
   uint64_t             srcfid;
   uint64_t             dstfid;
   uint32_t             units;
   uint32_t             reserved;
   union {
      mme_time_t        time_info;
      mme_byte_status_t byte_info;
   };
} mme_copy_status_t;

The structure mme_copy_status_t defines information about the current media copy or ripping operation. Its members include at least those described in the table below.

Member Type Description
cqid uint64_t The copy queue ID entry currently being copied or ripped.
srcfid uint64_t The file ID of the source file being copied or ripped.
dstfid uint64_t The file ID of the destination file.
units uint32_t The units (time or bytes) used to track progress of the media copy or ripping operation. See mme_copy_units_t below.
reserved uint32_t Reserved for internal use.
byte_info | time_info union Depending on the value of units, either the structure mme_time_t with the play time ripped, or the structure mme_byte_status_t with the number of bytes copied.

mme_copy_units_t

The enumerated type mme_copy_units_t defines the units used to measure progress during a media copy or ripping operation. It can have the following values:

mme_byte_status_t

typedef struct _mme_byte_status {
    uint64_t    bytepos;
    uint64_t    nbytes;
} mme_byte_status_t;

Media copy operations use byte_info to communicate the progress of a copy operation when mme_copy_units_t is set to MME_COPY_UNITS_BYTES. byte_info is a member of mme_copy_status_t; it uses the structure mme_byte_status_t to hold the copy progress information. Its members are described in the table below.

Member Type Description
bytepos uint64_t Number of bytes copied thus far.
nbytes uint64_t Total number of bytes to be copied.

time_info

Ripping operations use time_info to communicate the progress of a ripping operation when mme_copy_units_t is set to MME_COPY_UNITS_TIME_MS. A member of mme_copy_status_t, time_info uses the structure mme_time_t to hold the ripping progress information, in milliseconds:

See mme_time_t.

Events

None delivered.

Blocking and validation

This function blocks until it completes.

Returns:

0
Success.
-1
An error occurred (errno is set).

Classification:

QNX Neutrino

Safety:
Interrupt handler No
Signal handler No
Thread Yes

See also:

mme_mediacopier_add(), mme_mediacopier_cleanup(), mme_mediacopier_clear(), mme_mediacopier_disable(), mme_mediacopier_enable(), mme_mediacopier_remove(), mme_time_t