|
1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 |
|
17 /** |
|
18 @file |
|
19 @internalComponent |
|
20 */ |
|
21 |
|
22 #ifndef OMXILCLOCKCOMPONENTCMDSIF_H |
|
23 #define OMXILCLOCKCOMPONENTCMDSIF_H |
|
24 |
|
25 #include <openmax/il/khronos/v1_x/OMX_Component.h> |
|
26 |
|
27 class MOmxILClockComponentCmdsIf |
|
28 { |
|
29 public: |
|
30 /** |
|
31 This method is used to query for the current media clock time of the |
|
32 clock component. |
|
33 |
|
34 @param aMediaTime The clock component media time in OMX_TICKS. |
|
35 @return OMX_ERRORTYPE |
|
36 */ |
|
37 virtual OMX_ERRORTYPE GetMediaTime(OMX_TICKS& aMediaTime) const = 0; |
|
38 |
|
39 /** |
|
40 This method is used to query for the current wall clock of the clock |
|
41 component. |
|
42 |
|
43 @param aWallTime The clock component wall clock in OMX_TICKS. |
|
44 @return OMX_ERRORTYPE |
|
45 */ |
|
46 virtual OMX_ERRORTYPE GetWallTime(OMX_TICKS& aWallTime) const = 0; |
|
47 |
|
48 |
|
49 /** |
|
50 This method is used to query for the current state of the clock |
|
51 component. |
|
52 |
|
53 @param aClockState A OMX_TIME_CONFIG_CLOCKSTATETYPE structure. |
|
54 |
|
55 @return OMX_ERRORTYPE |
|
56 */ |
|
57 virtual OMX_ERRORTYPE GetClockState(OMX_TIME_CONFIG_CLOCKSTATETYPE& aClockState) const = 0; |
|
58 |
|
59 /** |
|
60 This method allows a client to request a particular timestamp |
|
61 |
|
62 @param apPrivate A pointer to any private data that the client wants to |
|
63 associate with the request. |
|
64 @param aMediaTime A timestamp, which is associated with some |
|
65 operation (e.g., the presentation of a frame) that |
|
66 the client shall execute at the time requested. |
|
67 @param aOffset Specifies the desired difference between the wall time |
|
68 when the timestamp actually occurs and the wall time |
|
69 when the request is to be fulfilled. |
|
70 @return OMX_ERRORTYPE |
|
71 */ |
|
72 virtual OMX_ERRORTYPE MediaTimeRequest(const OMX_PTR apPrivate, const OMX_TICKS aMediaTime, const OMX_TICKS aOffset) const = 0; |
|
73 |
|
74 /** |
|
75 This method sends the start time to the clock component |
|
76 |
|
77 @param aStartTime The starting timestamp of the stream |
|
78 @return OMX_ERRORTYPE |
|
79 */ |
|
80 virtual OMX_ERRORTYPE SetStartTime(const OMX_TICKS aStartTime) const = 0; |
|
81 |
|
82 /** |
|
83 This method updates the clock component's video reference clock. |
|
84 |
|
85 @param aVideoRef The media time of the video component. |
|
86 @return OMX_ERRORTYPE |
|
87 */ |
|
88 virtual OMX_ERRORTYPE SetVideoReference(const OMX_TICKS aVideoRef) const = 0; |
|
89 |
|
90 /** |
|
91 This method updates the clock component's audio reference clock. |
|
92 |
|
93 @param aAudioRef The media time of the audio component. |
|
94 @return OMX_ERRORTYPE |
|
95 */ |
|
96 virtual OMX_ERRORTYPE SetAudioReference(const OMX_TICKS aAudioRef) const = 0; |
|
97 |
|
98 /** |
|
99 This method checks the clock component availability |
|
100 |
|
101 @return TBool |
|
102 */ |
|
103 virtual OMX_BOOL IsClockComponentAvailable() const = 0; |
|
104 }; |
|
105 |
|
106 #endif // OMXILCLOCKCOMPONENTCMDSIF_H |
|
107 |