IInbandEvent::SendInbandSpanningEvent Method

[This documentation is preliminary and is subject to change.]
Inserts an in-band event into the output pin's data stream.

Syntax

HRESULT SendInbandSpanningEvent(
  [in]  GUID SBEEventTypeGUID,
  [in]  GUID SpanningEventGUID,
  [in]  WORD wEventDataSize,
  [in]  BYTE *pEventData
);

Parameters

  • SBEEventTypeGUID [in]
    Identifies the event category.

  • SpanningEventGUID [in]
    Identifies the event. See Remarks.

  • wEventDataSize [in]
    Size of the pEventData array in bytes.

  • pEventData [in]
    Pointer to a byte array that contains information about the event. If wEventDataSize is zero, this parameter must be NULL.

Return Value

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This event causes the filter to insert an empty media sample into the stream. The media sample does not contain any media data, but carries the event data. To get the event data, query the sample for the IAttributeGet interface and call IAttributeGet::GetAttrib or IAttributeGet::GetAttribIndexed. The attribute GUID is the value of the SpanningEventGUID parameter, and the attribute data is the value of the pEventData parameter.

The following events are defined.

Value Description
EVENTID_ARIBcontentSpanningEvent Signals the start of Integrated Services Digital Broadcasting (ISDB) content. No data is associated with this event.
EVENTID_AudioDescriptorSpanningEvent Contains an MPEG-2 descriptor for an audio stream. The event data is a byte array with the following layout:

  • Byte 0 contains the descriptor tag.
  • Byte 1 contains the length of the descriptor body.
  • The remaining bytes contain the descriptor body.
EVENTID_AudioTypeSpanningEvent Specifies the audio type of the data stream. The event data is a char that contains the audio_type field from the ISO 639 Language Descriptor.
EVENTID_CASFailureSpanningEvent Signals a failure in the condition access system (CAS). The event data depends on the CAS technology in use.
EVENTID_ChannelChangeSpanningEvent Signals the start or end of a channel change. The event data is a ChannelChangeInfo structure.
EVENTID_ChannelInfoSpanningEvent Contains information about the cable television channel. The event data is a ChannelInfo structure.
EVENTID_CSDescriptorSpanningEvent Contains a caption service descriptor. The event data is a SpanningEventDescriptor structure.
EVENTID_CtxADescriptorSpanningEvent Contains a content advisory descriptor. The event data is a SpanningEventDescriptor structure.
EVENTID_DualMonoSpanningEvent Specifies the audio languages for a dual-mono audio stream. The event data is a DualMonoInfo structure.
EVENTID_DVBScramblingControlSpanningEvent Indicates whether a Digital Video Broadcasting (DVB) program stream is scrambled. This event is signaled when the value of the transport_scrambling_control field changes. The event data is a DVBScramblingControlSpanningEvent structure.
EVENTID_EmmMessageSpanningEvent Contains information about an Entitlement Management Message (EMM) in a DVB data stream. The event data is a SpanningEventEmmMessage structure.
EVENTID_LanguageSpanningEvent Specifies the audio language. The event data is a LanguageInfo structure.
EVENTID_PBDAParentalControlSpanningEvent Contains information about the current parental control policy. The event data is a PBDAParentalControl structure.
EVENTID_PIDListSpanningEvent Contains a list of packet identifiers (PIDs) for the current stream. The event data is a PIDListSpanningEvent structure.
EVENTID_RRTSpanningEvent Contains information about a rating region table (RRT). The data is a SECTION structure.
EVENTID_SignalAndServiceStatusSpanningEvent Signals the current state of the television service. The event data is a member of the SignalAndServiceStatusSpanningEvent_State enumeration.
EVENTID_StreamIDSpanningEvent Contains a stream identifier descriptor. The event data has the same format as the EVENTID_AudioDescriptorSpanningEvent event.
EVENTID_StreamTypeSpanningEvent Specifies the stream type. The event data is a DWORD that contains a value from the MPEG2StreamType enumeration.
EVENTID_SubtitleSpanningEvent Contains a subtitling descriptor. The event data has the same format as the EVENTID_AudioDescriptorSpanningEvent event.
EVENTID_TeletextSpanningEvent Contains a teletext descriptor. The event data has the same format as the EVENTID_AudioDescriptorSpanningEvent event.

Requirements

Client Requires Windows 7.
IDL Declared in Bdaiface.idl.

See Also

IInbandEvent

Send comments about this topic to Microsoft

Build date: 12/4/2008