SDKSampleApp.Source.Utilities Class Reference

Static Public Member Functions
static void	BackgroundWorker_DoWork (object sender, DoWorkEventArgs args)
	The BackgroundWorker_DoWork method. More...
static void	BackgroundWorker_ProgressChanged (object sender, ProgressChangedEventArgs args)
	The BackgroundWorker_ProgressChanged method. More...
static void	BackgroundWorker_RunWorkerCompleted (object sender, RunWorkerCompletedEventArgs args)
	The BackgroundWorker_RunWorkerCompleted method. More...
static string	EncodeToBase64 (string toEncode)
	The EncodeToBase64 method. More...
static string	FormatFileSize (long byteValue, int decimalPlaces=1)
	The FormatFileSize method. More...
static Image	RotateImage (Image image, float rotationAngle)
	The RotateImage method. More...
static async Task< HttpResponseMessage >	SendRequest (Uri uri)
	The SendRequest method. More...

Static Private Member Functions
static int	AddRowToGridView (object[] item)
	The AddRowToGridView method. More...
static void	ChangeProgressViewState (bool isVisible)
	The ChangeProgressViewState method. More...

Detailed Description

Definition at line 17 of file Utilities.cs.

Member Function Documentation

static int SDKSampleApp.Source.Utilities.AddRowToGridView ( object[]  item )

inlinestaticprivate

The AddRowToGridView method.

Parameters

item	The item to add to the list.

Definition at line 23 of file Utilities.cs.

        {
            var rowIndex = 0;
            if (MainForm.Instance.dgvDataSources.InvokeRequired)
            {
                MainForm.Instance.dgvDataSources.Invoke(
                    new MethodInvoker(delegate { rowIndex = MainForm.Instance.dgvDataSources.Rows.Add(item); }));
            }
            else
                rowIndex = MainForm.Instance.dgvDataSources.Rows.Add(item);

            return rowIndex;
        }

static void SDKSampleApp.Source.Utilities.BackgroundWorker_DoWork ( object  sender, DoWorkEventArgs  args  )

inlinestatic

The BackgroundWorker_DoWork method.

Parameters

sender	The sender parameter.
args	The args parameter.

Definition at line 42 of file Utilities.cs.

        {
            MainForm.Instance.dgvDataSources.Invoke(new MethodInvoker(delegate { MainForm.Instance.dgvDataSources.Rows.Clear(); }));

            if (MainForm.CurrentDevices != null)
                MainForm.CurrentDevices.Clear();
            MainForm.CurrentDevices = MainForm.CurrentSystem.GetDevices();

            if (MainForm.CurrentDataSources != null)
                MainForm.CurrentDataSources.Clear();

            ChangeProgressViewState(true);
            MainForm.CurrentDataSources = MainForm.CurrentSystem.GetDataSources();

            var dataSourceTotal = MainForm.CurrentDataSources.Count;
            var dataSourceNum = 0;
            foreach (var dataSource in MainForm.CurrentDataSources)
            {
                dataSourceNum++;
                if (dataSource.Type != DataSource.Types.Video)
                    continue;

                var progress = ((decimal)dataSourceNum / dataSourceTotal) * 100;
                MainForm.Instance.bgWorker.ReportProgress((int)progress, null);
                Bitmap camIcon;
                if (dataSource.DataInterfaces.Any(item => (int) item.RenderType > 0 && (int) item.RenderType <= 4))
                {
                    camIcon = dataSource.State == DataSource.States.Offline ? Resources.cam_pano_offline : Resources.cam_pano;
                }
                else
                {
                    if (dataSource.IsPTZ)
                        camIcon = dataSource.State == DataSource.States.Offline ? Resources.cam_ptz_offline : Resources.cam_ptz;
                    else
                        camIcon = dataSource.State == DataSource.States.Offline ? Resources.cam_fixed_offline : Resources.cam_fixed;
                }

                object[] row = { camIcon, dataSource.Name, dataSource.Number.ToString() };
                var index = AddRowToGridView(row);
                var newRow = MainForm.Instance.dgvDataSources.Rows[index];
                newRow.Tag = dataSource;
            }

            MainForm.Instance.BeginInvoke((MethodInvoker)delegate
            {
                // If data source collection was successful enable the UI elements.
                MainForm.Instance.eventsToolStripMenuItem.Enabled = true;
                MainForm.Instance.manageToolStripMenuItem.Enabled = true;
                MainForm.Instance.btnSeek.Enabled = true;
                MainForm.Instance.btnPause.Enabled = true;
                MainForm.Instance.btnPlay.Enabled = true;
                MainForm.Instance.btnStop.Enabled = true;
                MainForm.Instance.btnSnapshot.Enabled = true;
                MainForm.Instance.btnRefreshDataSources.Enabled = true;
            });
        }

static void SDKSampleApp.Source.Utilities.BackgroundWorker_ProgressChanged ( object  sender, ProgressChangedEventArgs  args  )

inlinestatic

The BackgroundWorker_ProgressChanged method.

Parameters

sender	The sender parameter.
args	The args parameter.

Definition at line 104 of file Utilities.cs.

        {
            MainForm.Instance.pbLoadCameras.Invoke(
                new MethodInvoker(delegate { MainForm.Instance.pbLoadCameras.Value = args.ProgressPercentage; }));
        }

static void SDKSampleApp.Source.Utilities.BackgroundWorker_RunWorkerCompleted ( object  sender, RunWorkerCompletedEventArgs  args  )

inlinestatic

The BackgroundWorker_RunWorkerCompleted method.

Parameters

sender	The sender parameter.
args	The args parameter.

Definition at line 115 of file Utilities.cs.

        {
            ChangeProgressViewState(false);
        }

static void SDKSampleApp.Source.Utilities.ChangeProgressViewState ( bool  isVisible )

inlinestaticprivate

The ChangeProgressViewState method.

Parameters

isVisible

The value to set the visible property to.

Definition at line 124 of file Utilities.cs.

        {
            if (MainForm.Instance.pbLoadCameras.InvokeRequired)
            {
                MainForm.Instance.pbLoadCameras.Invoke(
                    new MethodInvoker(delegate { MainForm.Instance.pbLoadCameras.Visible = isVisible; }));
            }
            else
                MainForm.Instance.pbLoadCameras.Visible = isVisible;

            if (MainForm.Instance.lblAddingCameras.InvokeRequired)
            {
                MainForm.Instance.lblAddingCameras.Invoke(
                    new MethodInvoker(delegate { MainForm.Instance.lblAddingCameras.Visible = isVisible; }));
            }
            else
                MainForm.Instance.lblAddingCameras.Visible = isVisible;

            if (MainForm.Instance.btnRefreshDataSources.InvokeRequired)
            {
                MainForm.Instance.btnRefreshDataSources.Invoke(
                    new MethodInvoker(delegate { MainForm.Instance.btnRefreshDataSources.Visible = !isVisible; }));
            }
            else
                MainForm.Instance.btnRefreshDataSources.Visible = !isVisible;
        }

static string SDKSampleApp.Source.Utilities.EncodeToBase64 ( string  toEncode )

inlinestatic

The EncodeToBase64 method.

Parameters

toEncode

The string to encode to Base64.

Returns

The Base64 encoded string.

Definition at line 156 of file Utilities.cs.

        {
            var toEncodeAsBytes = Encoding.ASCII.GetBytes(toEncode);
            var returnValue = Convert.ToBase64String(toEncodeAsBytes);
            return returnValue;
        }

static string SDKSampleApp.Source.Utilities.FormatFileSize ( long  byteValue, int  decimalPlaces = 1  )

inlinestatic

The FormatFileSize method.

Parameters

byteValue	The size of the file in bytes.
decimalPlaces	The amount of decimal places to use.

Returns

The file size formatted as a readable string.

Definition at line 169 of file Utilities.cs.

        {
            string[] sizeSuffixes = { "bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" };
            if (byteValue < 0) { return "-" + FormatFileSize(-byteValue); }
            if (byteValue == 0) { return "0.0 bytes"; }


            var mag = (int)Math.Log(byteValue, 1024);
            var adjustedSize = (decimal)byteValue / (1L << (mag * 10));
            if (Math.Round(adjustedSize, decimalPlaces) < 1000)
                return string.Format("{0:n" + decimalPlaces + "} {1}", adjustedSize, sizeSuffixes[mag]);

            mag += 1;
            adjustedSize /= 1024;
            return string.Format("{0:n" + decimalPlaces + "} {1}", adjustedSize, sizeSuffixes[mag]);
        }

static Image SDKSampleApp.Source.Utilities.RotateImage ( Image  image, float  rotationAngle  )

inlinestatic

The RotateImage method.

Parameters

image	The image to be rotated.
rotationAngle	The angle (in degrees).

Returns

The rotated image.

Definition at line 192 of file Utilities.cs.

        {
            if (image == null)
                return null;

            // Create an empty image.
            var bitmap = new Bitmap(image.Width, image.Height);
            bitmap.SetResolution(image.HorizontalResolution, image.VerticalResolution);

            // Turn the bitmap into a graphics object.
            var graphics = Graphics.FromImage(bitmap);

            // Set the rotation point to the center of the image.
            graphics.TranslateTransform((float)bitmap.Width / 2, (float)bitmap.Height / 2);

            // Rotate the image.
            graphics.RotateTransform(rotationAngle);
            graphics.TranslateTransform(-(float)bitmap.Width / 2, -(float)bitmap.Height / 2);

            // Set the InterpolationMode to HighQualityBicubic to ensure a high
            // quality image once it is transformed to the specified size.
            graphics.InterpolationMode = InterpolationMode.HighQualityBicubic;

            // Draw the new image onto the graphics object.
            graphics.DrawImage(image, new Point(0, 0));

            // Dispose of the graphics object.
            graphics.Dispose();

            // Return the image.
            return bitmap;
        }

static async Task<HttpResponseMessage> SDKSampleApp.Source.Utilities.SendRequest ( Uri  uri )

inlinestatic

The SendRequest method.

Parameters

uri	The request Uri.

Returns

The response message.

Definition at line 230 of file Utilities.cs.

        {
            // Create a new WebClient instance.
            var client = new HttpClient();

            // Supply the username and password that was used to create the VideoXpert system.
            var request = new HttpRequestMessage(HttpMethod.Get, uri);
            request.Headers.Add("X-Serenity-User", EncodeToBase64(MainForm.CurrentUserName));
            request.Headers.Add("X-Serenity-Password", EncodeToBase64(MainForm.CurrentPassword));

            // Forces the WebClient to trust the security certificate handed back from the VideoXpert server.
            ServicePointManager.ServerCertificateValidationCallback = delegate { return true; };

            var response = await client.SendAsync(request);
            return response;
        }

---

The documentation for this class was generated from the following file:

• C:/Git/VxSDK-Samples/CSharpSample/CSharp/Source/Misc/Utilities.cs