BLOG | DOCUMENTATION | GITHUB

Home --> Documentations --> PJMEDIA Reference

pjmedia_event Struct Reference

#include <event.h>

Data Fields

pjmedia_event_type type
 
pj_timestamp timestamp
 
const void * src
 
const void * epub
 
union {
   pjmedia_event_fmt_changed_data   fmt_changed
 
   pjmedia_event_wnd_resized_data   wnd_resized
 
   pjmedia_event_wnd_closing_data   wnd_closing
 
   pjmedia_event_wnd_closed_data   wnd_closed
 
   pjmedia_event_mouse_btn_down_data   mouse_btn_down
 
   pjmedia_event_keyframe_found_data   keyframe_found
 
   pjmedia_event_keyframe_missing_data   keyframe_missing
 
   pjmedia_event_aud_dev_err_data   aud_dev_err
 
   pjmedia_event_vid_dev_err_data   vid_dev_err
 
   pjmedia_event_user_data   user
 
   pjmedia_event_media_tp_err_data   med_tp_err
 
   pjmedia_event_rx_rtcp_fb_data   rx_rtcp_fb
 
   void *   ptr
 
data
 

Detailed Description

This structure describes a media event. It consists mainly of the event type and additional data/parameters for the event. Applications can use pjmedia_event_init() to initialize this event structure with basic information about the event.

Field Documentation

◆ type

pjmedia_event_type pjmedia_event::type

The event type.

◆ timestamp

pj_timestamp pjmedia_event::timestamp

The media timestamp when the event occurs.

◆ src

const void* pjmedia_event::src

Pointer information about the source of this event. This field is provided mainly for comparison purpose so that event subscribers can check which source the event originated from. Usage of this pointer for other purpose may require special care such as mutex locking or checking whether the object is already destroyed.

◆ epub

const void* pjmedia_event::epub

Pointer information about the publisher of this event. This field is provided mainly for comparison purpose so that event subscribers can check which object published the event. Usage of this pointer for other purpose may require special care such as mutex locking or checking whether the object is already destroyed.

◆ fmt_changed

pjmedia_event_fmt_changed_data pjmedia_event::fmt_changed

Media format changed event data.

◆ wnd_resized

pjmedia_event_wnd_resized_data pjmedia_event::wnd_resized

Window resized event data

◆ wnd_closing

pjmedia_event_wnd_closing_data pjmedia_event::wnd_closing

Window closing event data.

◆ wnd_closed

pjmedia_event_wnd_closed_data pjmedia_event::wnd_closed

Window closed event data

◆ mouse_btn_down

pjmedia_event_mouse_btn_down_data pjmedia_event::mouse_btn_down

Mouse button down event data

◆ keyframe_found

pjmedia_event_keyframe_found_data pjmedia_event::keyframe_found

Keyframe found event data

◆ keyframe_missing

pjmedia_event_keyframe_missing_data pjmedia_event::keyframe_missing

Keyframe missing event data

◆ aud_dev_err

pjmedia_event_aud_dev_err_data pjmedia_event::aud_dev_err

Audio device error event data

◆ vid_dev_err

pjmedia_event_vid_dev_err_data pjmedia_event::vid_dev_err

Video device error event data

◆ user

pjmedia_event_user_data pjmedia_event::user

Storage for user event data

◆ med_tp_err

pjmedia_event_media_tp_err_data pjmedia_event::med_tp_err

Media transport error event data

◆ rx_rtcp_fb

pjmedia_event_rx_rtcp_fb_data pjmedia_event::rx_rtcp_fb

Receiving RTCP-FB event data

◆ ptr

void* pjmedia_event::ptr

Pointer to storage to user event data, if it's outside this struct

◆ 

union { ... } pjmedia_event::data

Additional data/parameters about the event. The type of data will be specific to the event type being reported.


The documentation for this struct was generated from the following file:

 


PJMEDIA small footprint Open Source media stack
Copyright (C) 2006-2008 Teluu Inc.