WARNING: The online documentation has moved to https://docs.pjsip.org.

Visit the new documentation at https://docs.pjsip.org:

BLOG | DOCUMENTATION | GITHUB

Home --> Documentations --> PJMEDIA Reference

pjmedia_converter_op Struct Reference

#include <converter.h>

Data Fields

pj_status_t(* convert )(pjmedia_converter *cv, pjmedia_frame *src_frame, pjmedia_frame *dst_frame)
 
void(* destroy )(pjmedia_converter *cv)
 
pj_status_t(* convert2 )(pjmedia_converter *cv, pjmedia_frame *src_frame, const pjmedia_rect_size *src_frame_size, const pjmedia_coord *src_pos, pjmedia_frame *dst_frame, const pjmedia_rect_size *dst_frame_size, const pjmedia_coord *dst_pos, pjmedia_converter_convert_setting *param)
 

Detailed Description

Converter operation.

Forward declaration for converter operation.

Field Documentation

◆ convert

pj_status_t(* pjmedia_converter_op::convert) (pjmedia_converter *cv, pjmedia_frame *src_frame, pjmedia_frame *dst_frame)

Convert the buffer of the source frame and save the result in the buffer of the destination frame, according to conversion format that was specified when the converter was created.

Note that application should use pjmedia_converter_convert() instead of calling this function directly.

Parameters
cvThe converter instance.
src_frameThe source frame.
dst_frameThe destination frame.
Returns
PJ_SUCCESS if conversion has been performed successfully.

◆ destroy

void(* pjmedia_converter_op::destroy) (pjmedia_converter *cv)

Destroy the converter instance.

Note that application should use pjmedia_converter_destroy() instead of calling this function directly.

Parameters
cvThe converter.

◆ convert2

pj_status_t(* pjmedia_converter_op::convert2) (pjmedia_converter *cv, pjmedia_frame *src_frame, const pjmedia_rect_size *src_frame_size, const pjmedia_coord *src_pos, pjmedia_frame *dst_frame, const pjmedia_rect_size *dst_frame_size, const pjmedia_coord *dst_pos, pjmedia_converter_convert_setting *param)

Convert a region in the buffer of the source frame and put the result into a region in the buffer of the destination frame, according to conversion format that was specified when the converter was created.

Note that application should use pjmedia_converter_convert2() instead of calling this function directly.

Parameters
cvThe converter instance.
src_frameThe source frame.
src_frame_sizeThe source frame size.
src_reg_posThe source region position.
dst_frameThe destination frame.
dst_frame_sizeThe destination frame size.
dst_reg_posThe destination region position.
paramThis is unused for now and must be NULL.
Returns
PJ_SUCCESS if conversion has been performed successfully.

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

 


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