gstreamer.SystemClock source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gstreamer.SystemClock;
26 
27 private import gobject.ObjectG;
28 private import gstreamer.Clock;
29 private import gstreamer.c.functions;
30 public  import gstreamer.c.types;
31 
32 
33 /**
34  * The GStreamer core provides a GstSystemClock based on the system time.
35  * Asynchronous callbacks are scheduled from an internal thread.
36  * 
37  * Clock implementors are encouraged to subclass this systemclock as it
38  * implements the async notification.
39  * 
40  * Subclasses can however override all of the important methods for sync and
41  * async notifications to implement their own callback methods or blocking
42  * wait operations.
43  */
44 public class SystemClock : Clock
45 {
46 	/** the main Gtk struct */
47 	protected GstSystemClock* gstSystemClock;
48 
49 	/** Get the main Gtk struct */
50 	public GstSystemClock* getSystemClockStruct(bool transferOwnership = false)
51 	{
52 		if (transferOwnership)
53 			ownedRef = false;
54 		return gstSystemClock;
55 	}
56 
57 	/** the main Gtk struct as a void* */
58 	protected override void* getStruct()
59 	{
60 		return cast(void*)gstSystemClock;
61 	}
62 
63 	/**
64 	 * Sets our main struct and passes it to the parent class.
65 	 */
66 	public this (GstSystemClock* gstSystemClock, bool ownedRef = false)
67 	{
68 		this.gstSystemClock = gstSystemClock;
69 		super(cast(GstClock*)gstSystemClock, ownedRef);
70 	}
71 
72 
73 	/** */
74 	public static GType getType()
75 	{
76 		return gst_system_clock_get_type();
77 	}
78 
79 	/**
80 	 * Get a handle to the default system clock. The refcount of the
81 	 * clock will be increased so you need to unref the clock after
82 	 * usage.
83 	 *
84 	 * Returns: the default clock.
85 	 *
86 	 *     MT safe.
87 	 */
88 	public static Clock obtain()
89 	{
90 		auto __p = gst_system_clock_obtain();
91 
92 		if(__p is null)
93 		{
94 			return null;
95 		}
96 
97 		return ObjectG.getDObject!(Clock)(cast(GstClock*) __p, true);
98 	}
99 
100 	/**
101 	 * Sets the default system clock that can be obtained with
102 	 * gst_system_clock_obtain().
103 	 *
104 	 * This is mostly used for testing and debugging purposes when you
105 	 * want to have control over the time reported by the default system
106 	 * clock.
107 	 *
108 	 * MT safe.
109 	 *
110 	 * Params:
111 	 *     newClock = a #GstClock
112 	 *
113 	 * Since: 1.4
114 	 */
115 	public static void setDefault(Clock newClock)
116 	{
117 		gst_system_clock_set_default((newClock is null) ? null : newClock.getClockStruct());
118 	}
119 }