Collapse All
libZPlay documentation (Win32)
IndexReferenceHome
PreviousUpNext
libZPlayCpp::zplay_PlayLoop Function

Play specified segment of song, in loop if needed.

C++
__stdcall __declspec(dllimport) int zplay_PlayLoop(ZPLAY_HANDLE handle, TTimeFormat fFormatStartTime, TStreamTime * pStartTime, TTimeFormat fFormatEndTime, TStreamTime * pEndTime, unsigned int nNumOfCycles, unsigned int fContinuePlaying);
File
Parameters
Parameters 
Description 
ZPLAY_HANDLE handle 
ZPLAY handle. Get this handle with zplay_CreateZPlay. 
TTimeFormat fFormatStartTime 
Time format of pStartTime parameter. With this parameter you need to specify which member of TStreamTime is valid. 
TStreamTime * pStartTime 
Pointer to TStreamTime structure specifying loop starting position. 
TTimeFormat fFormatEndTime 
Time format of pEndTime parameter. With this parameter you need to specify which member of TStreamTime is valid. 
TStreamTime * pEndTime 
Pointer to TStreamTime structure specifying loop ending position. 
unsigned int nNumOfCycles 
Number of loop cycles. This value can't be 0. If this value is 1, function will play portion from pStartTime to pEndTime once. If this value is 2, function will play portion from pStartTime to pEndTime twice ... 
unsigned int fContinuePlaying 
If this value is 0, playing will stop when loop is done with cycles. If this value is 1, playing will continue when loop is done with cycles. 
Return Values
Return Values 
Description 
1 
All OK. 
0 
Error. To get error message read here. 
Remarks

Previous playing will be stopped, function will seek to pStartTime and start playing. 

Note: Accuracy of seek position depends on interface settings. See accurate seek. 

Warning: This function will fail on dynamic stream. 

See Also
Example

Play loop from current position, loop length is 5 seconds, play 3 cycles, continue playing. 

ZPlay C++ Class interface  

TStreamTime pCurrentTime;
instance->GetPosition(&pCurrentTime); // starting position is current position
TStreamTime pEndTime;
pEndTime.ms = pCurrentTime.ms + 5000; // ending position is 5000 ms forward
instance->PlayLoop(tfMillisecond, &pCurrentTime, tfMillisecond, &pEndTime ,3, 1);

 

C Style interface 

TStreamTime pCurrentTime;
zplay_GetPosition(instance, &pCurrentTime); // starting position is current position
TStreamTime pEndTime;
pEndTime.ms = pCurrentTime.ms + 5000; // ending position is 5000 ms forward
zplay_PlayLoop(instance, tfMillisecond, &pCurrentTime, tfMillisecond, &pEndTime ,3, 1);
Group
Copyright (c) 2010. Zoran Cindori - All rights reserved.

Web: http://libzplay.sourceforge.net/

Email: zcindori@inet.hr

Made with Doc-O-Matic® Express

Doc-O-Matic