diguySoundInstance Class Declaration

diguySoundInstance.h

DI-Guy API Version 5.1.26

This file was automatically generated from comments in the C/C++ header file diguySoundInstance.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com

Alphabetical Index

Includes: declspec_diguy.h

class diguySoundInstance

class BDI_DECLSPEC_diguy diguySoundInstance
{
public:
    const char* get_name();
    int play(double offset = 0.0);
    int get_is_playing();
    int stop();
    int set_automatic_destroy_flag();
#ifdef CPLUSPLUS_ONLY
    bdiSoundInstance* get_scripted_object() {return m_scripted_object;}
};

function diguySoundInstance::get_name

Prototype:

const char* get_name();
Returns:

name of the sound used by the sound instance.

Callable From:

function diguySoundInstance::play

Prototype:

int play(double offset = 0.0);
Description:

This function causes the sound to play immediately, starting from the specified time offset. The sound will continue until it has completed, or it is stopped.

Returns:

0 on success, -1 on failure

Callable From:

function diguySoundInstance::get_is_playing

Prototype:

int get_is_playing();
Returns:

1 if the sound is playing; 0 if not

Callable From:

function diguySoundInstance::stop

Prototype:

int stop();
Description:

This function causes this sound to stop. It does not destroy the sound instance. The sound instance can be played again if desired.

Arguments:

fadeout_intervaltime spent trying to smooth over any motion seams; e.g. set to 0.5 for a smooth fade-out, set it to 0 for an immediate stop
(Fading out may not be supported)

Returns:

0 on success, -1 on failure

Callable From:

function diguySoundInstance::set_automatic_destroy_flag

Prototype:

int set_automatic_destroy_flag();
Description:

This function causes the sound instance to be automatically deleted when the sound has completed. No further calls through the diguySoundInstance object can or should be made, so this function should only be called once all durations, reps, etc. have been set.

Returns:

0 on success, -1 on failure

Callable From:

function diguySoundInstance::get_scripted_object

Prototype:

bdiSoundInstance* get_scripted_object();

Alphabetical Index


Copyright (C) 1992-2003

Boston Dynamics

ALL RIGHTS RESERVED.

These coded instructions, statements, and computer programs contain unpublished proprietary information of Boston Dynamics and are protected by Copyright Laws of the United States. They may not be used, duplicated, or disclosed in any form, in whole or in part, without the prior written consent from Boston Dynamics.

RESTRICTED RIGHTS LEGEND

Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Sofware clause at DFARS 252.227-7013 and/or in similar or successor clauses in the FAR, or the DOD or NASA FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished-rights reserved under the Copyright Laws of the United States.

Contractor/Manufacturer is:

Boston Dynamics/515 Massachusetts Avenue/Cambridge MA 02139.