MediaObserver Interface#

Playback and recording components process events through a user-defined Observer object derived from MediaObserver.

oasis::MediaObserver is defined in OasisMedia.h as follows:

class MediaObserver : public std::enable_shared_from_this<MediaObserver>
{
public:
    MediaObserver();
    virtual ~MediaObserver();

    //recording or playing started and stopped
    virtual void onStarted(void *user_data, const char *file_path);
    virtual void onStopped(void *user_data, media_report_reason_t reason, void *details);
    //recording a new file
    virtual void onFileChanged(void *user_data, const char *new_file_path);
    virtual void onFileDeleted(void *user_data, const char *deleted_file_path);
    virtual void onError(void *user_data, media_report_reason_t reason, void *details);

    //periodic report every 1 second.
    virtual void onInfo(void *user_data, MediaInfo *info);
    virtual void onInfoEx(void *user_data, MediaInfoEx *info);

    //player paused and resumed
    virtual void onPaused(void *user_data, MediaInfo *info);
    virtual void onResumed(void *user_data, MediaInfo *info);

    //event recording started and completed(aborted)
    virtual void onEventRecordingStarted(void *user_data, media_report_reason_t reason, const char *file_path);
    virtual void onEventRecordingCompleted(void *user_data, media_report_reason_t reason, const char *file_path);

    //motion recording started and completed(aborted)
    virtual void onMotionRecordingStarted(void *user_data, media_report_reason_t reason, const char *file_path);
    virtual void onMotionRecordingCompleted(void *user_data, media_report_reason_t reason, const char *file_path);

    virtual void queryNewFilePath(void *user_data, recording_mode_t file_type, bool rear_camera_on, bool sound_on, std::string &file_path);

    virtual void onSnapshotCompleted(void *user_data, uint32_t snapshot_id, int32_t camera_id, int error, const std::vector<char> &jpeg_image_data, const struct timeval &timestamp);
};

Header File#

OasisMedia.h

Functions#

General media_report_reason_t constant values are as follows:

For the recording component, media_report_reason_t constant values are as follows:

For the playback component, media_report_reason_t constant values are as follows:

Structures#

Example#

Users of the recording component define a class with MediaObserver as a base class, and pass it as a parameter when calling the oasis::startRecording function. Below is an example of creating MyRecordingObserver and passing it to oasis::startRecording.

std::shared_ptr<MyRecordingObserver> recording_observer = std::make_shared<MyRecordingObserver>();
RecorderRef recorder = createRecorder(parameters);
startRecording(recorder, recording_observer, nullptr /*user_data*/);

Below is an example of outputting MediaInfoEx to the console. The dumpInfoEx function is used in other example code resources.

void bytesToString(size_t size, char *size_string)
{
    if(size >= 1024*1024) {
        sprintf(size_string, "%.2fMB", (double)size/1048576);
    } else if(size >= 1024) {
        sprintf(size_string, "%.2fKB", (double)size/1024);
    } else {
        sprintf(size_string, "%dB", size);
    }
}

void dumpInfoEx(MediaInfoEx* info)
{
    int h, m, s, u;
    char normal_qsize[128], event_qsize[128], in_size[128], out_size[128], cache_in_size[128];
    char video1_size[128], video2_size[128], meta_size[128], audio_size[128], file_size[128];
    parseUsec(info->durationUs, h, m, s, u);

    TRACE0("Recording duration \033[33m%02d:%02d:%02d.%06d\033[0m, wq#%d(%d), eq#%d(%d), meq#%d(%d), nohits#%u, mb.avail#%d/%d (free mem %.3fMB, cpu %.2f%%)\r\n", h, m, s, u, info->writerStat.curSamples, info->writerStat.maxSamples, info->timeshiftStat.curSamples, info->timeshiftStat.maxSamples, info->writerStat.motionStat.curSamples, info->writerStat.motionStat.maxSamples, info->mediaCacheStat.nohits_, info->mediaCacheStat.free_buffer_count_, info->mediaCacheStat.total_buffer_count_, (double)oasis::getFreeMemorySize()/1024.0/1024.0, getCPUUsage());

    //offs state
    bytesToString(info->offsStat.qNormalSize, normal_qsize);
    bytesToString(info->offsStat.qEventSize, event_qsize);

    bytesToString(info->offsStat.inSize, in_size);
    bytesToString(info->offsStat.outSize, out_size);

    bytesToString(info->mediaCacheStat.in_size_, cache_in_size);


    TRACE0("    cache: during %d msec, in %s\r\n", info->mediaCacheStat.check_duration_, cache_in_size);
    TRACE0("    offs: n#%d, e#%d, nz#%s, ez#%s, during %d msec: in %s out %s elapsed %d msec \r\n", info->offsStat.qNormalCount, info->offsStat.qEventCount, normal_qsize, event_qsize, info->offsStat.checkDuration, in_size, out_size, info->offsStat.elapsedSum);

    //print recording stat in details
    bytesToString(info->writerStat.video1Length, video1_size);
    bytesToString(info->writerStat.video2Length, video2_size);
    bytesToString(info->writerStat.metaLength, meta_size);
    bytesToString(info->writerStat.audioLength, audio_size);
    bytesToString(info->writerStat.fileLength, file_size);
    TRACE0("    %s: video1 %s, video2 %s, meta %s, audio %s, file %s\n", info->sniffing?"sniffing":"recording", video1_size, video2_size, meta_size, audio_size, file_size);

    if(info->writerStat.motionStat.recording) {
        bytesToString(info->writerStat.motionStat.video1Length, video1_size);
        bytesToString(info->writerStat.motionStat.video2Length, video2_size);
        bytesToString(info->writerStat.metaLength, meta_size);
        bytesToString(info->writerStat.audioLength, audio_size);
        bytesToString(info->writerStat.fileLength, file_size);
        TRACE0("    motion: video1 %s, video2 %s, meta %s, audio %s, file %s\n", video1_size, video2_size, meta_size, audio_size, file_size);
    }

    if(info->timeshiftStat.recording) {
        bytesToString(info->timeshiftStat.video1Length, video1_size);
        bytesToString(info->timeshiftStat.video2Length, video2_size);
        bytesToString(info->timeshiftStat.metaLength, meta_size);
        bytesToString(info->timeshiftStat.audioLength, audio_size);
        bytesToString(info->timeshiftStat.fileLength, file_size);
        TRACE0("    event: video1 %s, video2 %s, meta %s, audio %s, file %s\n", video1_size, video2_size, meta_size, audio_size, file_size);
    }
}