IAccAvSession Interface Reference

Inherits IAccSecondarySession.

---

Detailed Description

IAccAvSession is used for controlling audio/video calls. Currently this interface works only on Win32.

Public Types

• enum AccAvStreamType {
    AccAvStreamType_AudioSend,
    AccAvStreamType_AudioReceive,
    AccAvStreamType_VideoSend,
    AccAvStreamType_VideoReceive
  }
• enum AccAvSessionType {
    AccAvSessionType_Talk,
    AccAvSessionType_Rtp,
    AccAvSessionType_RtpConference
  }
• enum AccAvLocalVideoMode {
    AccAvLocalVideoMode_Hidden,
    AccAvLocalVideoMode_PictureInPicture
  }
• enum AccAvSessionProp {
    AccAvSessionProp_Video = 1000,
    AccAvSessionProp_NetworkQuality,
    AccAvSessionProp_SessionType,
    AccAvSessionProp_SessionTypeProposed,
    AccAvSessionProp_PromoteCentralized,
    AccAvSessionProp_LocalVideoMode
  }
• typedef enum
  IAccAvSession::AccAvStreamType AccAvStreamType
• typedef enum
  IAccAvSession::AccAvSessionType AccAvSessionType
• typedef enum
  IAccAvSession::AccAvLocalVideoMode AccAvLocalVideoMode
• typedef enum
  IAccAvSession::AccAvSessionProp AccAvSessionProp

Public Member Functions

• HRESULT Property_ ([in] AccAvSessionProp property,[out, retval] xp_variant *value)
• HRESULT Property_ ([in] AccAvSessionProp property,[in] xp_kvariant value)
• HRESULT GetVideoWindow ([in] xp_kstr userName,[out, retval] IDispatch **window)
• HRESULT SendDtmf ([in] xp_kstr tones)
• HRESULT SendSoundEffect ([in] xp_kstr url)
• HRESULT Hold ([in] xp_vbool on)
• HRESULT StartRecording ([in] xp_kstr file)
• HRESULT StopRecording ()

---

Member Typedef Documentation

typedef enum IAccAvSession::AccAvStreamType IAccAvSession::AccAvStreamType

typedef enum IAccAvSession::AccAvSessionType IAccAvSession::AccAvSessionType

typedef enum IAccAvSession::AccAvLocalVideoMode IAccAvSession::AccAvLocalVideoMode

typedef enum IAccAvSession::AccAvSessionProp IAccAvSession::AccAvSessionProp

Properties for the Property method.

---

Member Enumeration Documentation

enum IAccAvSession::AccAvStreamType

Enumerator:

AccAvStreamType_AudioSend
AccAvStreamType_AudioReceive
AccAvStreamType_VideoSend
AccAvStreamType_VideoReceive

enum IAccAvSession::AccAvSessionType

Enumerator:

AccAvSessionType_Talk
AccAvSessionType_Rtp
AccAvSessionType_RtpConference

enum IAccAvSession::AccAvLocalVideoMode

Enumerator:

AccAvLocalVideoMode_Hidden
AccAvLocalVideoMode_PictureInPicture

enum IAccAvSession::AccAvSessionProp

Properties for the Property method.

Enumerator:

AccAvSessionProp_Video	Checks if the AV session is a video session [get] xp_bool*
AccAvSessionProp_NetworkQuality	The "quality" of the AV session, based on latency/packet loss, range is 0-100 [get] xp_s32*
AccAvSessionProp_SessionType	The type of AV session [get] AccAvSessionType*
AccAvSessionProp_SessionTypeProposed	The type of AV session that the invitee is proposing to transition to [get] AccAvSessionType*
AccAvSessionProp_PromoteCentralized	Whether Invite() should cause a move to a centralized conference or not [get] xp_bool* [put] xp_bool
AccAvSessionProp_LocalVideoMode	How your own video is displayed to you (or not) [get] AccAvLocalVideoMode* [put] AccAvLocalVideoMode

---

Member Function Documentation

HRESULT IAccAvSession::Property_	(	[in] AccAvSessionProp	property,
		[out, retval] xp_variant *	value
	)			[get]

DEPRECATED. Use IAccSecondarySession::Property instead. Get a specific property of the session.

HRESULT IAccAvSession::Property_	(	[in] AccAvSessionProp	property,
		[in] xp_kvariant	value
	)			[set]

DEPRECATED. Use IAccSecondarySession::Property instead. Set a specific property of the session.

HRESULT IAccAvSession::GetVideoWindow	(	[in] xp_kstr	userName,
		[out, retval] IDispatch **	window
	)

Gets the video window for the specified user. Pass NULL to get your own (preview) window.

HRESULT IAccAvSession::SendDtmf

(

[in] xp_kstr

tones

)

Sends a DTMF sound to the session.

HRESULT IAccAvSession::SendSoundEffect

(

[in] xp_kstr

url

)

Sends a sound effect to the session.

HRESULT IAccAvSession::Hold

(

[in] xp_vbool

on

)

Put this session on/off hold.

HRESULT IAccAvSession::StartRecording

(

[in] xp_kstr

file

)

Propose a session type transition to the other attendees.

[in] AccAvSessionType sessionType Record the sound from the session to a WAV file.

HRESULT IAccAvSession::StopRecording

(

)

Stop recording the session.