Click here to Skip to main content
15,887,683 members
Articles / Programming Languages / C#
Article

The Multimedia Timer for the .NET Framework

Rate me:
Please Sign up or sign in to vote.
4.89/5 (66 votes)
1 Mar 20063 min read 392.9K   20.2K   90   103
A .NET class encapsulating the Win32 multimedia timer.

Introduction

The Win32 multimedia timer services provide the greatest degree of timing accuracy. They allow you to schedule timing events at a higher resolution than other timer services. This can be useful in a multimedia application where timing accuracy is of utmost importance. For example, a MIDI application needs timing events that are as finely grained as possible.

Unfortunately, the Win32 multimedia timer is not part of the .NET Framework. However, by using the .NET interoperability services, the multimedia timer can be brought into the .NET fold.

The multimedia timer class

The multimedia Timer class encapsulates several of the Win32 multimedia functions to make using the multimedia timer in the .NET environment easy and painless. The Timer class has Start and Stop methods for starting and stopping the Timer respectively. It also implements the IComponent interface so that it can be dragged and dropped onto the Windows Designer. When the Timer Period has elapsed, it raises a Tick event. All are very simple and straightforward. In addition, the class has several properties:

  • Capabilities – Gets a structure representing the multimedia timer capabilities.
  • Mode – Gets or sets the timer mode.
  • Period – Gets or sets the time between timer events in milliseconds.
  • Resolution – Gets or sets the timer resolution in milliseconds.
  • SynchronizingObject - Gets or sets the ISynchronizeInvoke object the timer is using for marshaling events.

The Capabilities property is a static property that gets a TimerCaps structure representing your system's multimedia timer's minimum and maximum Period values. Each multimedia Timer you create has the same capabilities. Note, I have not been able to find hard documentation for this, but it appears that the maximum number of multimedia timers you can create on Windows XP is 16. I assume this is true for other versions of Windows as well, but I don't know.

The Mode property gets or sets the Timer's firing mode. If the Mode is set to TimerMode.OneShot, the Timer will fire only once after the Period value has elapsed. Otherwise, if it is set to TimerMode.Periodic, it will fire continuously each time the Period value has elapsed.

The Period property gets or sets the time in milliseconds between each Tick event.

The Resolution property gets or sets the Timer's accuracy. The lower the value of this property, with zero being the lowest, the higher the accuracy. However, the documentation for the Win32 multimedia timer warns that "To reduce system overhead, however, you should use the maximum value appropriate for your application".

The SynchronizingObject property gets or sets the timer's ISynchronizeInvoke object. Initially, this property is null. When you initialize to an ISynchronizeInvoke object, the timer will marshal the events it generates to the same thread in which the ISynchronizeInvoke object is running. For example, if you are using the timer in a Windows Form, you can initialize the timer's SynchronizingObject to the Form itself. The timer will then marshal its events to the Form's thread.

Conclusion

I hope you find this class useful. My hope is that it will find its way into .NET multimedia applications. Comments and suggestions are most welcome.

History

  • 11/22/2003 - Article submitted.
  • 10/24/2005 - Major article revision, source code rewritten and updated.
  • 03/01/2006 - Article revision, source code rewritten and updated.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


Written By
United States United States
Aside from dabbling in BASIC on his old Atari 1040ST years ago, Leslie's programming experience didn't really begin until he discovered the Internet in the late 90s. There he found a treasure trove of information about two of his favorite interests: MIDI and sound synthesis.

After spending a good deal of time calculating formulas he found on the Internet for creating new sounds by hand, he decided that an easier way would be to program the computer to do the work for him. This led him to learn C. He discovered that beyond using programming as a tool for synthesizing sound, he loved programming in and of itself.

Eventually he taught himself C++ and C#, and along the way he immersed himself in the ideas of object oriented programming. Like many of us, he gotten bitten by the design patterns bug and a copy of GOF is never far from his hands.

Now his primary interest is in creating a complete MIDI toolkit using the C# language. He hopes to create something that will become an indispensable tool for those wanting to write MIDI applications for the .NET framework.

Besides programming, his other interests are photography and playing his Les Paul guitars.

Comments and Discussions

 
GeneralThanks very much Pin
Julian11223-May-10 20:05
Julian11223-May-10 20:05 
Generalberlus@walla.co.il Pin
Berlus3-Feb-10 4:16
Berlus3-Feb-10 4:16 
GeneralThanks Pin
_brice2-Feb-10 1:50
_brice2-Feb-10 1:50 
GeneralMake 'multiple' waitable timer using this Multi media timer Pin
R Krabbenborg5-Jan-10 9:41
R Krabbenborg5-Jan-10 9:41 
GeneralRe: Make 'multiple' waitable timer using this Multi media timer Pin
Bit_flipper16-Jun-10 4:27
Bit_flipper16-Jun-10 4:27 
GeneralRe: Make 'multiple' waitable timer using this Multi media timer Pin
Miiika_19-Oct-10 22:13
Miiika_19-Oct-10 22:13 
Generalbroken examples Pin
Sk9329-Sep-09 5:52
Sk9329-Sep-09 5:52 
GeneralRe: broken examples Pin
Leslie Sanford29-Sep-09 6:54
Leslie Sanford29-Sep-09 6:54 
Sk93 wrote:
Your demo project is different to your source code.


The source code zip file is only meant to contain the bare minimum of source files, so I only included the Timer.cs file. As far as I can tell (it's been years since I've looked at the code), the Timer.cs file in the source code zip file is identical to that one in the demo zip file.

Sk93 wrote:
In the demo project, the main form designer is broken.


There's a dead reference to my StateMachineToolkit assembly. You can delete that, and the demo project should compile fine. Just make sure that the demo is set as the start up project.

Sk93 wrote:
Also, in neither projects does the timer appear to be a drag-n-droppable component as mentioned in the article :/


After compiling the Multimedia project, you can add the timer to the toolbox by right clicking on the toolbox and choosing Browse from the dialog box. Then navigate to the Multimedia folder and find the compiled assembly (I think it's in the obj folder). Click on the assembly, and it should be added to the toolbox. From there you can drag n' drop it to your projects.
GeneralProblem with accuracy Pin
Ondrej8413-Feb-09 0:03
Ondrej8413-Feb-09 0:03 
QuestionProblem: Events are not being fired at the specified interval Pin
charday21-Nov-08 1:44
charday21-Nov-08 1:44 
AnswerRe: Problem: Events are not being fired at the specified interval Pin
PittyAlex2-Jan-09 23:09
PittyAlex2-Jan-09 23:09 
QuestionThe Timer class is sealed, I cannot inherit it. Pin
uu88ii24-Jun-08 20:24
uu88ii24-Jun-08 20:24 
Generalsorry,a mistakenly vote Pin
uu88ii9-Jun-08 1:42
uu88ii9-Jun-08 1:42 
GeneralRe: sorry,a mistakenly vote Pin
Ilíon18-Sep-08 14:25
Ilíon18-Sep-08 14:25 
GeneralBug with TimerMode.OneShot and SyncronizingObject Pin
patrickcbrown20-Sep-07 8:49
patrickcbrown20-Sep-07 8:49 
GeneralRe: Bug with TimerMode.OneShot and SyncronizingObject Pin
Leslie Sanford20-Sep-07 8:57
Leslie Sanford20-Sep-07 8:57 
GeneralRe: Bug with TimerMode.OneShot and SyncronizingObject Pin
patrickcbrown21-Sep-07 11:39
patrickcbrown21-Sep-07 11:39 
GeneralRe: Bug with TimerMode.OneShot and SyncronizingObject Pin
Leslie Sanford21-Sep-07 11:48
Leslie Sanford21-Sep-07 11:48 
GeneralRe: Bug with TimerMode.OneShot and SyncronizingObject Pin
patrickcbrown20-Sep-07 8:58
patrickcbrown20-Sep-07 8:58 
GeneraltimeBeginPeriod/timeEndPeriod Pin
ujr14-Feb-07 6:29
ujr14-Feb-07 6:29 
GeneralRe: timeBeginPeriod/timeEndPeriod Pin
Ruben Jönsson5-Oct-07 3:20
Ruben Jönsson5-Oct-07 3:20 
GeneralCan't open demo form (Form1.cs) in designer Pin
DPRoberts10-Aug-06 9:38
DPRoberts10-Aug-06 9:38 
GeneralRe: Can't open demo form (Form1.cs) in designer Pin
DPRoberts10-Aug-06 9:42
DPRoberts10-Aug-06 9:42 
GeneralRe: Can't open demo form (Form1.cs) in designer Pin
Leslie Sanford10-Aug-06 11:02
Leslie Sanford10-Aug-06 11:02 
QuestiontimeSetEvent fundamentally flawed? Pin
hotbot8212-Jun-06 1:31
hotbot8212-Jun-06 1:31 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.