OpenSpeech Browser

Getting Started
Architecture Description
Integration Guide

Copyright (c) 1998-2001 SpeechWorks International, Inc. All Rights Reserved.



VXIapResult TriggerPlay

(struct VXIapInterface* pThis,
  VXIapPlayListNode* playList,
  const VXIint playListSize,
  VXIapPlayListNode** invalidNode)

Triggers playing audio to the caller, non-blocking
This routine is asynchronous, in that it does not block - it only triggers the begin of a play operation. This interface only supports one play operation at a time. If another play operation is initiated via TriggerPlay( ) or TriggerStreamingPlay( ) before this play operation completes, a VXIap_RESULT_BUSY error is returned.

When this function returns successfully, ownership of the entire play list is passed to the Audio Player, which may then modify the previous and next pointers in the play list as desired to support the immplementation. The Audio Player is then responsible for calling the Destroy( ) method of each play node as each node is no longer needed. If this function returns an error, however, this function must not have made any changes to the play list (particularly the previous and next pointers), and ownership is returned to the client.

Parameters:
playList - [IN] List of play nodes to play to the caller, on success ownership is passed
playListSize - [IN] Number of nodes in the play list
invalidNode - [OUT] On error, this is set to point at the node in the play list that triggered the error, or NULL if there is a generic error.
Returns:
VXIap_RESULT_SUCCESS on success
VXIap_RESULT_BUSY if a play is already in progress
VXIap_RESULT_NON_FATAL_ERROR if the MIME content type is not supported
Another VXIap_RESULT_[...] code for severe errors

Alphabetic index Hierarchy of classes



This page was generated with the help of DOC++.