Table of Contents Index NMS Glossary Previous Page Next Page (Page 19 of 41 in this chapter) Version


vceGetOpenInfo

Description

Gets status information about an open voice object.

Prototype

DWORD vceGetOpenInfo ( VCEHD vh,
VCE_OPEN_INFO
*openinfo,
unsigned size)

vh Handle of an open voice object.

openinfo Pointer to a buffer to receive the following structure:

typedef struct
{
DWORD size;
DWORD filetype;
DWORD openmode;
DWORD encoding;
CTAHD ctahd;
} VCE_OPEN_INFO;
See the Details section for a description of these fields.

size Size, in bytes, of the openinfo buffer.

Return Values

Events

Details

This function retrieves status information about an open voice file or memory object.

The VCE_OPEN_INFO structure contains the following fields:
Field

Description

size

Number of bytes written to the buffer pointed to by openinfo.

filetype

The type of voice file (VCE_FILETYPE_xxx), or zero (0) if memory.

openmode

VCE_PLAY_ONLY or VCE_PLAY_RECORD.

encoding

Voice encoding of all messages in the file or memory block.

ctahd

The context handle used when vh was obtained.

The VCE_OPEN_INFO data remains constant for a given handle as long as it is open.

Use vceGetContextInfo to get time varying information pertaining to the context identified by ctahd.

Use vceGetEncodingInfo to get information about the encoding.

See Also

vceGetContextInfo, vceGetEncodingInfo

Example


/* Get the encoding of an open voice file*/

unsigned myGetEncoding (VCEHD vh)
{
VCE_OPEN_INFO openinfo;

if (vceGetOpenInfo (vh, &openinfo, sizeof openinfo) != SUCCESS)
return 0;
return openinfo.encoding;
}


Table of Contents Index NMS Glossary Previous Page Next Page (Page 19 of 41 in this chapter) Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.