Zu Hauptinhalten wechseln

FV Decipher Unterstützung

Alle Themen, Ressourcen für FV Decipher benötigt.

 
decipher

Video Player Element

Usage fees apply for video files. Please contact your Account Manager for pricing specifics.

Overview

The Video Player element allows researchers to expose their survey respondents to a short video clip for product review and enhanced engagement. It utilizes a text question base with the following rows, which will appear in the survey report and any exported data:

  • play_count:The number of times the respondent has watched the video in full. If a respondent does not play the video, a value of 0 will show in the data for them.
  • time_elapsed:The most amount of time (in seconds) spent watching the video across each time it was viewed. If a respondent does not play the video, a value of 0 will show in the data for them.
  • watermark_id: If applicable, the value of the burned-in watermark that was shown for the respondent. This field is only visible in the reports/data if burned-in watermarking is added to the Video Player. See section 2 below for more details.

The following is an example of the Video Player element as it would appear within a survey:

The Video Player uses HTML 5, and the new version is available in survey compats 137+.

1: Adding a Video Player Element

You can set the "Show" filter to display only elements that are compatible or optimized for the devices allowed for your project. Click here to learn how to view and modify your project settings.

You can add a Video Player to any survey using the Survey Editor. To add a Video Player, click "Add Survey Element", select the "Multimedia" tab and choose "Video Player." Then click "Insert":

We recommend adding only a single Video Player question per page, as differing stylevars can lead to potential complications.

Once you've inserted the Video Player, you can change the question label and style settings, upload a video file, and adjust the default question text in the areas provided:

Your question label should not contain the word "ad", as this will result in your video being blocked by any adblock software.  

1.1: Uploading a Video File

Videos must be uploaded using the system file manager. Click here to learn how to access the file manager and upload your video.

Usage fees apply for video files. Please contact your Account Manager for pricing specifics.

Video files must be submitted in one of the following formats:

  • .mp4 (mobile compatible)
  • .mov (mobile compatible)

Be sure to note your video ID, as this field is required to link your video to a Video Player element.

1.2: Configuring the Style Settings

Once you've uploaded your video file, you will need to link it to a Video Player using the style settings menu within the element. To link your video file and configure the display settings for your video player, click the "Style: Video Player" link at the top right of the Video Player element:

The "Question Display Options" window will appear, where you can adjust each of the following settings for your video player:

Additional information about each feature will appear when you mouse-over the text in the window.

  • Video ID: Enter the unique video ID provided in the file manager. For complete instruction on how to upload videos, click here.
  • Video Width: Enter the width of the video in pixels. E.g., 640
  • Video Height: Enter the height of the video in pixels. E.g., 360
  • Allow Pause: When checked, the video can be paused by the respondent. When unchecked, pausing is not available.
  • Allow Replay: When checked, the video can be replayed by the respondent. When unchecked, replaying is not available.
  • Allow Auto-Start (Desktop): When checked, the video auto-starts on desktop computers. When unchecked, video is manually started on desktop (i.e., respondent must click "play"). Due to mobile browser limitations, auto-start is only available for desktop browsers.
  • Auto Advance: When checked, the respondent is automatically advanced to the next page when the video is finished playing. When unchecked, the respondent will be required to click continue/finish to advance to the next page.
  • Allow Fullscreen:  When checked, the video can be viewed in fullscreen. However, if this is used the watermark feature will not be available. When unchecked, the video is not available in fullscreen.
  • Hide Volume Controls: When checked, the volume controls will not be shown to respondents. When unchecked, the volume controls will show to respondents.
  • Hide Poster on Pause/Finish: When checked, the poster image will not be shown to respondents. When unchecked, the poster image will show to respondents.
  • Must Watch Video: When checked, this disallows respondents from continuing in the survey until the video has completed playing.
  • Enable continue button after...: The value entered here will disable the Continue button for xx seconds or until xx% of the video is played. Requires “Must Watch Video” to be checked. For example, if "15" is entered, the Continue button will be disabled for 15 seconds. If "15%" is entered, the Continue button will be disabled until 15% of the video has been played.
  • Watermark: The value entered here will be used for watermarking videos across users. For example, if you enter "ACME" here, this text will show as the watermark for every respondent. It is also possible to use simple javascript to apply a unique watermark per respondent. For example,"${uuid}" will use each respondent's unique ID as their watermark. Likewise, "${gv.request.getRemote()}" will use each respondent's IP address as their watermark. If this field is left blank, no watermark will be applied.
  • Watermark Position: Determines the position of the watermark. This becomes the starting position if the watermark is animated.

Click "Save and Preview" to preview your settings at any time. Once you are satisfied with your changes, click "Save and Close".

Watermarks cannot accept the following character: ’

2: Making Videos More Secure

Requires that you have survey:edit permission for the project.

If your video includes sensitive materials, you may prefer a more secure and traceable method for delivering it to respondents. In this case, you can use burned-in watermarks instead of, or in conjunction with, the default overlays. The burned-in approach makes it more difficult for respondents to pirate or publish your content, as it uniquely tags your videos, allowing you to trace them back to specific individuals.

2.1: Requesting Watermarked Videos

Burned-in watermarks must be requested through the Decipher API. To request a watermarked video, send the following POST request, where survey is the full path to your survey, source is the URL of the file you'd like to upload, and quantity is the number of unique videos you desire:

POST /api/v1/surveys/survey/source/videos?unique_watermarks=1&quantity=xxxx

quantity can be set to any value from 1 - 10,000.

For example, you could use the command below to create 2,000 unique watermarked videos:

POST /api/v1/surveys/survey/source/videos?unique_watermarks=1&quantity=2000

When deciding how many videos you will need for your survey, it's important to keep in mind that every view counts -- even partial respondents who view your video before dropping out of the survey will be assigned a unique watermarked video. 

Once all videos have been used, respondents will see a system error message at the page with the Video Player. We recommend adding a quota element to instead force respondents to overquota if this happens.

The following URL parameters can also be specified within your POST request:

Attribute

Type

Description

description

string (optional)

Sets where the videos will be displayed in file manager. Can be set to company or project.

Default: project

  • project shows only to the project it was uploaded to.
  • company shows to all projects in the users company

privacy

string (optional)

Sets where the videos will be displayed in file manager. Can be set to company or project

Default: project

  • project shows only to the project it was uploaded to.
  • company shows to all projects in the users company.

unique_watermark_options

dict (optional)

Adds the specified customizations to the watermark.

position

string (optional)

Sets the position of the watermark in the video.

Default: middle center

Can be set to:

  • top left
  • top center
  • top right
  • middle left
  • middle center
  • middle right
  • bottom right
  • bottom center
  • bottom left

color

string (optional)

Sets the color of the watermarked text.

Default: rgba(255, 255, 255, 64)

Acceptable Formats:

  • HEX: #FFFFFF
  • RGB/A: rgb(0, 0, 0) / rgba(255, 255, 255, 128)
  • HSL: hsl(0, 100%, 50%)
  • Common HTML colors: red, yellow, green, etc.

size

string (optional)

Sets the size of the watermark as a percentage of the video width in increments of 10.

Default: 70%

 

Click here for more information on customizing your video watermarks using the API.

2.2: Adding Watermarked Videos to the Survey

Once processed, the above commands will return a video ID to be used in the video player for your survey. To add the video ID to your player, go back into the Survey Editor and click "Style: Video Player" within the Video Player element. Then enter the ID in the "Video ID" field and click "Save and Close":

Finally, use the XML Editor to add the following code to the video player question tag:

videoplayer:unique_watermarks="1"

This setting will communicate to the player that a unique watermark is required for each respondent.

2.3: Requesting Additional Videos

Once you have created a watermarked video, you can request additional videos through the Decipher API at any time. To request additional watermarked videos for an existing video, send the following PUT request, where survey is the full path to your survey, video_id is the ID of the video to be updated, and quantity is set to the desired number of unique videos:

PUT /api/v1/surveys/survey/videos/video_id?quantity=xxxx

Additionally, you can add the URL parameter keep to your request to ensure your video is not deleted by any cleanup scripts. For example:

PUT /api/v1/surveys/survey/videos/video_id?quantity=xxxx&keep=1

Click here for more information on creating multiple videos using the API.

quantity can be set to any value from 1 - 10,000.

2.4: Storing Video Data

After all videos have completed processing, a database file called watermark_videos_<videoID>.txt is created for data storage and management. The video player then uses the database file with an auxillary survey database to assign a burned-in watermarked unique video ID to a respondent (similar to how gift codes are stored for an incentivized survey).

If needed, this database file can be manually created using the following command, where survey is the full path to your survey, and video_id is the ID of the video to be updated:

POST - /api/v1/surveys/survey/videos/video_id/create_db_file 

Non-burned-in watermarked and burned-in watermarked videos are stored within the guidelines of our content retention policy, however there are two exceptions for this. Non-burned-in watermarked videos with privacy set to "Company" will not be removed. Additionally, videos can be flagged so they are not deleted using the following command, where survey is the full path to your survey, and video_id is the ID of the video to be updated:

PUT - /api/v1/surveys/survey/videos/video_id?keep=1 

Click here for more details on this.

3: Limitations

The video player has some limitations in certain instances:

  • For best compatibility on desktop/tablet/mobile devices, please use only the HTTP protocol when sending survey links out.
  • Using HTTPS with the video player transfers video securely when the survey/page is loaded via HTTPS on mobile (Android / iOS devices).

When using HTTPS, the JS console will sometimes contain mixed content warnings, but the video is transferred securely. The warnings are related to Brightcove's API, and not critical.

  • The size of the video file shown in the video player must be less than 2GB.
  • When viewed in fullscreen:
    • Watermark is not supported for iOS
    • Different player is used for iPhone (iOS)
    • Fullscreen enables pause and replay by default, overriding any settings for iPhone (iOS)
  • When viewed on mobile:
    • iPhone (iOS) will play in fullscreen by default and enable the seekbar
  • Autostart is only available for desktop browsers.
  • War dieser Artikel hilfreich?