#include <framehook.h>

Collaboration diagram for ast_framehook_interface:

[legend]

Data Fields
ast_framehook_chan_fixup_callback	chan_breakdown_cb

ast_framehook_chan_fixup_callback	chan_fixup_cb

ast_framehook_consume_callback	consume_cb

void *	data

ast_framehook_destroy_callback	destroy_cb

int	disable_inheritance

ast_framehook_event_callback	event_cb

uint16_t	version

Detailed Description

This interface is required for attaching a framehook to a channel.

Definition at line 229 of file framehook.h.

Field Documentation

◆ chan_breakdown_cb

ast_framehook_chan_fixup_callback chan_breakdown_cb

chan_breakdown_cb is optional. This function is called when another channel is masqueraded into the channel that a framehook is running on and should be used to evaluate whether the framehook should remain on the channel.

Definition at line 248 of file framehook.h.

Referenced by ast_framehook_list_fixup().

◆ chan_fixup_cb

ast_framehook_chan_fixup_callback chan_fixup_cb

chan_fixup_cb is optional. This function is called when the channel that a framehook is running on is masqueraded and should be used to move any essential framehook data onto the channel the old channel was masqueraded to.

Definition at line 244 of file framehook.h.

Referenced by ast_framehook_list_fixup().

◆ consume_cb

ast_framehook_consume_callback consume_cb

consume_cb is optional. This function is called to query whether the framehook is consuming frames of a specific type at this time. If this callback is not implemented it is assumed that the framehook will consume frames of all types.

Definition at line 240 of file framehook.h.

Referenced by ast_framehook_list_contains_no_active_of_type().

◆ data

void* data

This pointer can represent any custom data to be stored on the !framehook. This data pointer will be provided during each event callback which allows the framehook to store any stateful data associated with the application using the hook.

Definition at line 255 of file framehook.h.

Referenced by ast_channel_suppress(), ast_framehook_attach(), ast_framehook_list_contains_no_active_of_type(), ast_framehook_list_fixup(), ast_jb_create_framehook(), attach_framehook(), dtmfstore_exec(), fax_detect_attach(), fax_gateway_attach(), frame_drop_helper(), frame_trace_helper(), framehook_detach(), framehook_list_push_event(), native_rtp_bridge_framehook_attach(), and set_hold_intercept().

◆ destroy_cb

ast_framehook_destroy_callback destroy_cb

destroy_cb is optional. This function is called immediately before the framehook is destroyed to allow for stored_data cleanup.

Definition at line 236 of file framehook.h.

Referenced by framehook_detach().

◆ disable_inheritance

int disable_inheritance

disable_inheritance is optional. If set to non-zero, when a channel using this framehook is masqueraded, detach and destroy the framehook instead of moving it to the new channel.

Definition at line 251 of file framehook.h.

Referenced by ast_framehook_list_fixup().