342 * |
342 * |
343 */ |
343 */ |
344 gint GetState(); |
344 gint GetState(); |
345 |
345 |
346 /** |
346 /** |
|
347 * Get stream ID. |
|
348 * |
|
349 * This function can be called at any time. |
|
350 * |
|
351 * @return |
|
352 * Unique ID of the stream. |
|
353 * |
|
354 */ |
|
355 gint GetStreamId(); |
|
356 |
|
357 /** |
347 * Get stream type. |
358 * Get stream type. |
348 * |
359 * |
349 * This function can be called at any time. |
360 * This function can be called at any time. |
350 * |
361 * |
351 * The possible types are: |
362 * The possible types are: |
352 * QTMS_STREAM_UPLINK |
363 * TMS_STREAM_UPLINK |
353 * QTMS_STREAM_DOWNLINK |
364 * TMS_STREAM_DOWNLINK |
354 * |
365 * |
355 * @return |
366 * @return |
356 * Stream type indicating whether it is an uplink or downlink. |
367 * Stream type indicating whether it is an uplink or downlink. |
357 * |
|
358 */ |
|
359 gint GetStreamId(); |
|
360 |
|
361 /** |
|
362 * Get stream ID. |
|
363 * |
|
364 * This function can be called at any time. |
|
365 * |
|
366 * @return |
|
367 * Unique ID of the stream. |
|
368 * |
368 * |
369 */ |
369 */ |
370 gint GetStreamType(); |
370 gint GetStreamType(); |
371 |
371 |
372 /** |
372 /** |
379 * request will be ignored and the function will return QTMS_RESULT_SUCCESS. |
379 * request will be ignored and the function will return QTMS_RESULT_SUCCESS. |
380 * |
380 * |
381 * Upon stream's successful transition to initialized state, the stream will |
381 * Upon stream's successful transition to initialized state, the stream will |
382 * be in the QTMS_STREAM_INITIALIZED state. |
382 * be in the QTMS_STREAM_INITIALIZED state. |
383 * |
383 * |
384 * QUESTION??? Should we do the initial checking here??? (for source, |
384 * Before stream can transition to initialized state the following |
385 * sink and other settings) |
385 * objects must be added to the stream: |
386 * |
386 * CS call: UPL: mic source and modem sink |
387 * @return |
387 * CS call: DNL: modem source and speaker sink |
|
388 * IP call: UPL: mic source, codec format and client sink |
|
389 * IP call: DNL: client source, codec format and speaker sink |
|
390 * |
|
391 * @return |
|
392 * Common return codes: |
388 * QTMS_RESULT_SUCCESS if stream transitioned to the initialized state. |
393 * QTMS_RESULT_SUCCESS if stream transitioned to the initialized state. |
389 * QTMS_RESULT_INVALID_STATE if stream has not transitioned to the |
394 * QTMS_RESULT_INVALID_STATE if stream has not transitioned to the |
390 * QTMS_STREAM_UNINITIALIZED state. |
395 * QTMS_STREAM_INITIALIZED state. |
|
396 * QTMS_RESULT_FORMAT_TYPE_UNSPECIFIED (IP call only) when stream |
|
397 * has no format attached to it. |
|
398 * QTMS_RESULT_UNINITIALIZED_OBJECT when stream has no sink or source |
|
399 * element attached to it. |
391 * |
400 * |
392 */ |
401 */ |
393 gint Init(); |
402 gint Init(); |
394 |
403 |
395 /** |
404 /** |
405 * be in the QTMS_STREAM_PAUSED state. |
414 * be in the QTMS_STREAM_PAUSED state. |
406 * |
415 * |
407 * Note: In QTMS Ver 1.0.0.0, pausing stream for CS call is not supported. |
416 * Note: In QTMS Ver 1.0.0.0, pausing stream for CS call is not supported. |
408 * |
417 * |
409 * @return |
418 * @return |
410 * QTMS_RESULT_SUCCESS if stream successfully transitioned to the paused |
419 * Common return codes: |
411 * state. |
420 * QTMS_RESULT_SUCCESS if stream successfully transitioned to the |
|
421 * paused state. |
412 * QTMS_RESULT_INVALID_STATE if stream is not in the |
422 * QTMS_RESULT_INVALID_STATE if stream is not in the |
413 * QTMS_STREAM_INITIALIZED or QTMS_STREAM_STARTED state. |
423 * QTMS_STREAM_INITIALIZED or QTMS_STREAM_PAUSED state. |
414 * |
424 * |
415 */ |
425 */ |
416 gint Pause(); |
426 gint Pause(); |
417 |
427 |
418 /** |
428 /** |
430 * |
440 * |
431 * Upon stream's successful transition to the started state, the stream will |
441 * Upon stream's successful transition to the started state, the stream will |
432 * be in the QTMS_STREAM_STARTED state. |
442 * be in the QTMS_STREAM_STARTED state. |
433 * |
443 * |
434 * @return |
444 * @return |
435 * QTMS_RESULT_SUCCESS if stream successfully transitioned to the paused |
445 * Common return codes: |
436 * state. |
446 * QTMS_RESULT_SUCCESS if stream successfully transitioned to the |
|
447 * started state. |
437 * QTMS_RESULT_INVALID_STATE if stream is not in the |
448 * QTMS_RESULT_INVALID_STATE if stream is not in the |
438 * QTMS_STREAM_INITIALIZED or QTMS_STREAM_PAUSED state. |
449 * QTMS_STREAM_INITIALIZED or QTMS_STREAM_STARTED state. |
439 * |
450 * |
440 */ |
451 */ |
441 gint Start(); |
452 gint Start(); |
442 |
453 |
443 /** |
454 /** |
451 * |
462 * |
452 * Upon stream's successful transition to the started state, the stream will |
463 * Upon stream's successful transition to the started state, the stream will |
453 * be in the QTMS_STREAM_INITIALIZED state. |
464 * be in the QTMS_STREAM_INITIALIZED state. |
454 * |
465 * |
455 * @return |
466 * @return |
456 * QTMS_RESULT_SUCCESS if stream successfully transitioned to the paused |
467 * Common return codes: |
457 * state. |
468 * QTMS_RESULT_SUCCESS if stream successfully transitioned to the |
|
469 * stopped state. |
458 * QTMS_RESULT_INVALID_STATE if stream is not in the |
470 * QTMS_RESULT_INVALID_STATE if stream is not in the |
459 * QTMS_STREAM_STARTED or QTMS_STREAM_PAUSED state. |
471 * QTMS_STREAM_STARTED or QTMS_STREAM_PAUSED state. |
460 * |
472 * |
461 */ |
473 */ |
462 gint Stop(); |
474 gint Stop(); |