Kaltura Video Module for Drupal 7.x User Manual. Version: 2.0

Transcription

1 Kaltura Vide Mdule fr Drupal 7.x User Manual Versin: 2.0

2 Kaltura Business Headquarters 200 Park Avenue Suth, New Yrk, NY , USA Tel.: Cpyright 2015 Kaltura Inc. All Rights Reserved. Designated trademarks and brands are the prperty f their respective wners. Use f this dcument cnstitutes acceptance f the Kaltura Terms f Use and Privacy Plicy.

3 Cntents Preface... 4 Abut this Manual... 4 Audience... 4 Dcument Cnventins... 4 Related Dcumentatin... 5 Sectin 1 Overview f the Kaltura Vide Mdule fr Drupal... 6 Kaltura Mdule fr Drupal Key Features... 6 Gettting Started... 6 Activating the Mdule t Wrk with yur Kaltura Accunt... 7 Sectin 2 Cnfiguring the Kaltura Vide Mdule... 7 Creating a Publisher Accunt frm the Drupal Site... 8 Using an Existing Publisher Accunt... 9 Sectin 3 Kaltura Media Fields Using the Kaltura Media Field in a Cntent Type Adding the Kaltura Media Field Cnfiguring Settings fr the Kaltura Media Field Kaltura Media Field Cntributin Elements Widget Types Add Media Settings Vide Only Audi Only Image Only All Media types Managing the Cntent Type Display Expanding Kaltura Media Entity with Additinal Fields Ppulating Kaltura Media Fields with Cntent Sectin 4 Additinal Integratin Pints Synchrnizing the Kaltura Publisher Accunt t Drupal Editing Cntent Metadata Drupal Views Integratin Integratin with Drupal Permissins Drupal Search Integratin Debugging Kaltura Mdule Kaltura Vide Mdule fr Drupal 7.x User Manual 3

4 Preface This preface cntains the fllwing tpics: Abut this Manual Audience Dcument Cnventins Related Dcumentatin Abut this Manual This manual cntains useful infrmatin abut hw t use the Kaltura Vide Mdule fr Drupal 7.x. Kaltura prvides mdules fr bth Drupal 6 and 7, hwever the instructins in this manual are specifically fr use with the Kaltura Vide Mdule fr Drupal 7. NOTE: Please refer t the fficial and latest prduct release ntes fr last-minute updates Technical supprt may be btained directly frm: Kaltura Supprt Cntact Us: Please send yur dcumentatin-related cmments and feedback r reprt mistakes t We are cmmitted t imprving ur dcumentatin and yur feedback is imprtant t us. Audience This manual is primarily intended fr Drupal administratrs. The manual assumes familiarity with Drupal 7 and fcuses n peratins specific t Kaltura Vide Mdule, while standard Drupal 7 peratins that are assciated are mentined in brief. Dcument Cnventins Kaltura uses the fllwing admnitins: Nte Wrkflw NOTE: Identifies imprtant infrmatin that cntains helpful suggestins. Wrkflw: Prvides wrkflw infrmatin. 1. Step 1 2. Step 2 Kaltura Vide Mdule fr Drupal 7.x User Manual 4

5 Related Dcumentatin Fr mre dcumentatin n Drupal, please visit Drupal cmmunity dcumentatin. Kaltura Vide Mdule fr Drupal 7.x User Manual 5

6 SECTION 1 Overview f the Kaltura Vide Mdule fr Drupal Kaltura's Vide Mdule fr Drupal makes it easy t add the rbust capabilities f Kaltura's pen surce vide platfrm t any Drupal site. The Kaltura Vide Mdule fr Drupal handles every aspect f yur vide and rich-media needs, including transcding, uplading and imprting cntent, hsting and streaming n Kaltura s servers, and mre. The mdule was develped specifically fr Drupal, and seamlessly integrates with ther features and mdules, such as fields, crn, views, blcks, and Drupal permissins. Kaltura Mdule fr Drupal Key Features Empwer Drupal websites with a full vide and rich media experience Uplad media in any frmat vides will be transcded t web-playable frmats by the Kaltura system Hst cntent by Kaltura and stream cntent frm tier 1 glbal CDNs such as Akamai and Limelight Netwrks thrugh Kaltura s full integratin with them - t assure quality f service, and minimize verhead Full metadata synced between Kaltura and the Drupal site Easily add rich media t existing cntent types using Kaltura Media Field representatin f rich media Fully integrate with Drupal Views - including predefined views t ease integratin Enhance user interactin by allwing users t add vide cmments with ne click n any page Cllect statistics number f plays fr each vide cllected and updated n the vide nde Cntrl Drupal permissins integratin an administratr can decide wh can view and wh can edit cntent Gettting Started Dwnlad the Kaltura Vide Mdule fr Drupal 7.x at: Cntinue t install the mdule as yu wuld fr any Drupal mdule and then activate the mdule. NOTE: Additinal dependent mdules are required t cmplete the installatin. Required mdules are ctls, Entity API, Libraries, and Views. The mdule als requires the Kaltura SDK library, which shuld be installed int the /sites/all/libraries/kalturaclient directry. Yu can use Drush cmmands t install it autmatically: drush kaltura-client-install Kaltura Vide Mdule fr Drupal 7.x User Manual 6

7 SECTION 2 Cnfiguring the Kaltura Vide Mdule After yu install the mdule, yu will need t activate the mdule with yur Kaltura accunt. Activating the Mdule t Wrk with yur Kaltura Accunt T activate the Drupal mdule with yur Kaltura accunt 1. Set the server settings. - Select the Kaltura Server that yu want t use. 2. Select the Ntificatin URL (Optinal). 3. Select the Partner t use. Create a publisher accunt r assciate the mdule t an existing publisher accunt in Kaltura. 4. Accept the Kaltura service Terms f Use. 5. Click Submit. T select the Server Settings 1. Select the Cnfiguratin menu. 2. In the Media sectin, select Kaltura mdule settings. 3. Enter the Server URL. T select the Ntificatin URL 1. Select the Cnfiguratin menu. 2. In the Media sectin, select Kaltura mdule settings. 3. Enter the Ntificatin URL (ptinal). See Synchrnizing the Kaltura Publisher Accunt t Drupal fr mre infrmatin. T select the a Partner (publisher accunt) t use 1. Select the Cnfiguratin menu. 2. In the Media sectin, select Kaltura mdule settings. 3. Select a partner. This tggle assciates the mdule t the publisher accunt. Yu can select either: New - Create a publisher accunt frm the Drupal site. Existing - Enter yur user name and credentials f yur existing Kaltura accunt. Kaltura Vide Mdule fr Drupal 7.x User Manual 7

8 Creating a Publisher Accunt frm the Drupal Site T create a publisher accunt using Drupal 1. Select the Cnfiguratin menu. 2. In the Media sectin, select Kaltura mdule settings. 3. In the Partner radi selectin, chse New. 4. The New Partner Registratin sectin is displayed. 5. Enter infrmatin fr the mandatry fields. Kaltura Vide Mdule fr Drupal 7.x User Manual 8

9 Using an Existing Publisher Accunt T create a publisher accunt using Drupal 1. Select the Cnfiguratin menu. 2. In the Media sectin, select Kaltura mdule settings. 3. In the Partner sectin, chse Existing. 4. The Existing Partner Registratin sectin is displayed. 5. Enter yur Kaltura Partner ID, the lgin , and passwrd fr yur Kaltura accunt. 6. Accept the Kaltura service Terms f Use. 7. Click Submit. NOTE: and Passwrd in this frm are nly used nce fr the initial cnnectin and are nt stred in Drupal after that. Secret key retrieved frm KMC is used fr all API calls ging frward. Kaltura Vide Mdule fr Drupal 7.x User Manual 9

10 SECTION 3 Kaltura Media Fields Kaltura integrates with Drupal 7 at a field level, prviding the granularity fr integratin with a variety f Drupal implementatins. As ther fields in Drupal, the Kaltura Media Field may be added t cntent types, cmments, user prfiles, and all ther types f blcks f cntent. The Kaltura Media field may be cnfigured t allw certain media types (i.e. vide, audi, image), fr different display ptins, and fr different media cntributin ptins. These cnfiguratin ptins synergize with Drupal s innate field and cntent types cnfiguratin, like permissins and displays, and tgether enable yu t easily build the media use-cases that apply t yu. Using the Kaltura Media Field in a Cntent Type This sectin cntains the fllwing tpics: Adding the Kaltura Media Field Cnfiguring Settings fr the Kaltura Media Field Kaltura Media Field Cntributin Elements Managing the Cntent Type Display Ppulating Kaltura Media Fields with Cntent Adding the Kaltura Media Field T add the Kaltura Media Field 1. Select the Structure tab and in the Label clumn, select a Cntent type. 2. In the Operatins clumn, select Manage Fields. The Manage Fields tab is displayed. 3. Enter a field name in the Add new field bx. 4. In the Name clumn, enter the name f the field in lwer case. This is the field name that Drupal will identify. 5. In the Field clumn, select Kaltura Media field. 6. Select a widget frm the Widget clumn drp dwn. (See Widget Types). The widget yu select frms the apprpriate element t edit yur data. 7. Click Save and cntinue t cnfigure the settings fr the Kaltura Media field. Depending n yur widget chice, a cnfiguratin windw fr the field is displayed. The fllwing is an example f a Kaltura Media field created fr uplading vide nly. Kaltura Vide Mdule fr Drupal 7.x User Manual 10

11 Kaltura Media Fields Cnfiguring Settings fr the Kaltura Media Field This sectin describes the ptins and settings fr the Kaltura Media field. All Kaltura features, such as setting the cnversin prfile and CDN cnfiguratin, wrk ut f the bx and can be set within the Kaltura Management Cnsle. See the KMC User Manual fr mre infrmatin. Kaltura Media Field Cntributin Elements Yu can define tw types f cntributin elements fr the Kaltura Media field: Widget Types Add Media Settings Widget Types The widget determines the types f media yu can uplad t the Kaltura Media field. This applies t bth uplading new cntent frm the Kaltura Cntributin Wizard and re-using existing cntent. The fllwing lists the types f widgets that yu can set fr a Kaltura Media Field. Vide Only allws yu t uplad nly vides thrugh the Kaltura Cntributin Wizard. Use nly when the Add Media Settings are set t Add new media. Audi Only - allws yu t uplad nly audi files thrugh the Kaltura Cntributin Wizard. Use nly when the Add Media Settings are set t Add new media. Image Only - allws yu t uplad nly image files thrugh the Kaltura Cntributin Wizard. Use nly when the Add Media Settings are set t Add new media. All Media Types - allws yu t uplad all three types f cntent - vide, audi, and images - thrugh the Kaltura Cntributin Wizard Add Media Settings The Add Media Settings ptins are dependent n the widget type selected when yu define the Kaltura Media field. The fllwing settings are available: Add new media nly - allws yu t uplad new media nly Use existing media nly - allws yu t chse frm upladed and synced cntent nly Use existing media and add new media allws yu t uplad new media and chse frm existing upladed cntent When yu add new media, cntent is upladed t yur Kaltura accunt as well as synced t the Drupal database. T change the widget type 1. Select the Structure tab and then select a cntent type. 2. In the Operatins clumn, select Manage Fields. 3. In the Widget clumn, click n the widget type. The Change Widget panel is displayed. Kaltura Vide Mdule fr Drupal 7.x User Manual 11

12 Kaltura Media Fields 4. Change the Widget type and click Cntinue. Vide Only T cnfigure the Kaltura Media Field settings fr the vide nly widget 1. In the Manage Fields tab, click n edit in the Operatins clumn. 2. Cnfigure the fllwing field settings: PLAYER SETTINGS Kaltura Vide Mdule fr Drupal 7.x User Manual 12

13 Kaltura Media Fields Name Descriptin Cmments Vide Player Select a player frm the list f players that are cnfigured in yur KMC. Create new player Click t create a new player in the KMC. Yu will be prmpted fr yur Kaltura credentials t access yu KMC accunt. Player Width Player Height Yu can change the player Width t accmmdate yur display per field. Default value: 400 Yu can change the player Height t accmmdate yur display per field. Default value: 330 Sets the default value fr this field. This value may be verridden in the display settings per field instance, Sets the default value fr this field. This value may be verridden in the display settings per field instance, Delivery Type Select frm the drpdwn ptins: See the KMC User Manual fr mre infrmatin. Advanced Click Advanced t chse a player that is nt cnfigured in yur Kaltura accunt. The advanced ptin pens the Custm Player UI_Cnf field where yu can enter the UIcnf ID fr the player yu want t use. This ptin is intended fr advanced Kaltura users and fr Kaltura supprt and administratrs. THUMBNAIL SETTINGS This sectin is relevant when selecting a thumbnail display fr the Kaltura Media field. See Managing the Cntent Type Display. Kaltura Vide Mdule fr Drupal 7.x User Manual 13

14 Kaltura Media Fields Name Descriptin Cmments Thumbnail Width Thumbnail Height Rtate Thumbnails fr Vide Items Enter the thumbnail width. Default value: 80 Enter the thumbnail height. Default value: 45 Check t shw a thumbnail slideshw preview f the vide when hvering ver the thumbnail Sets the default value fr this field. It can be verridden in the display settings per field instance. Sets the default value fr this field. It can be verridden in the display settings per field instance. 3. Click Save field settings. Audi Only T cnfigure settings fr the audi nly widget 1. In the Manage Fields tab, click n edit in the Operatins clumn. 2. Cnfigure the fllwing settings as fr vide nly: Player Settings Cntent Ingestin 3. Click Save field settings. Image Only T cnfigure settings fr the image nly widget 1. In the Manage Fields tab, click n edit in the Operatins clumn. 2. Cnfigure the fllwing settings as fr vide nly: Image settings Enter the Image width Enter the Image height Thumbnail Settings Cntent Ingestin 3. Click Save field settings. All Media types T cnfigure settings fr the all media types widget 1. In the Manage Fields tab, click n edit in the Operatins clumn. 2. Cnfigure the fllwing settings as fr vide nly: Player settings Cntent Ingestin 3. Click Save field settings. Kaltura Vide Mdule fr Drupal 7.x User Manual 14

15 Kaltura Media Fields Managing the Cntent Type Display Yu can change the display f the cnfigured fields frm the default setting, fr each instance f the field and fr each different custm display. T manage the Kaltura Media field display 1. Select the Structure tab, and then select Cntent Types. 2. Select the cntent type yu want t cnfigure. 3. In the Operatin clumn, click Manage Display t cnfigure the display/frmat ptins. Chse the Drupal Label frm the drp-dwn menu. Select Abve, Inline, r Hidden. Chse the Display frmat ptin fr the Kaltura Media Field. Fr example, the ptins fr vide are as fllws: 4. Custmize yur display (ptinal). 5. Click Save. Kaltura Vide Mdule fr Drupal 7.x User Manual 15

16 Kaltura Media Fields T custmize the display fr a specific instance f the field 1. Select the Structure tab and then select Cntent Types. 2. Select the cntent type yu want t cnfigure. 3. In the Operatin clumn, click Manage Display t cnfigure the display/frmat ptins. 4. Click Custmize Display Settings and select the settings yu want fr yur display mdes. The ptins yu select - fr example, Teaser, RSS, etc. - will be displayed in the manage display screen fr further custmizatin. 5. Click n the Display mde - fr example, Teaser - and then click the icn t pen the instance specific custmizatin fields. 6. Custmize the fields. 7. Click Update. Expanding Kaltura Media Entity with Additinal Fields Yu can extend the Kaltura Media Entity in Drupal with additinal custm fields and synchrnize their value with data frm KMC. T create new custm fields fr a Kaltura entity 1. G t Cnfiguratin. 2. In the Media sectin, select Kaltura mdule settings and then select Manage Fields. 3. Add a new field frm the drp dwn: Kaltura Vide Mdule fr Drupal 7.x User Manual 16

17 Kaltura Media Fields 4. Enter field name and widget type. 5. Click Save. T synchrnize data frm KMC with Drupal custm fields 1. G t Cnfiguratin. 2. In the Media sectin, select Kaltura mdule settings and then select Fields Mapping. 3. Fr each f the custm fields in Drupal select the crrespnding custm field in KMC: 4. Click Save cnfiguratin Ppulating Kaltura Media Fields with Cntent After a Kaltura Media Field is created in a cntent type, each time cntent f this type is created the cntent editr can ppulate the field with cntent. T ppulate the Kaltura Media field 1. Select Cntent and then select Add Cntent. The label yu defined fr each Kaltura Media Field is displayed. 2. Click the relevant label. The ptins t add cntent fr the specific field are dependent n the type f Add Media Settings that were set fr the field. See Add Media Settings. If yu selected Add new media, the cntent editr will nly be able t uplad new media t ppulate the field. If yu selected Use existing media nly, the cntent editr will nt be able t uplad new media cntent. If yu selected Use existing media and add new media the cntent editr will be able t uplad new media as well as chse frm existing upladed cntent The fllwing example displays a label created fr adding new and existing media. Kaltura Vide Mdule fr Drupal 7.x User Manual 17

18 Kaltura Media Fields Add Media Use existing media and add new media 3. T srt the cntent, click n the clumn table headings fr Title and Created By. 4. T search thrugh yur media cntent, enter a text string and click Apply. NOTE: If yu selected mre than ne media type, yu can filter the type f cntent fr yur search by using the checkbxes The label Add New (highlighted in the screensht abve) appears nly when the field is cnfigured t Add new media. Clicking Add New initiates the Kaltura Cntributin Wizard flw. See Adding Media thrugh the Kaltura Cntributin Wizard. 5. After yu select/find the media that yu want t use in this specific cntent, click Insert. In the create/edit Cntent type page, the selected cntent is displayed as yu specified in the display frmat. T remve the cntent fr the Kaltura Media field fr a vide, click n the red x. Kaltura Vide Mdule fr Drupal 7.x User Manual 18

19 Kaltura Media Fields 6. Click Save. T remve the cntent fr the Kaltura Media field fr an image, select Remve. After yu save the cntent, the cntent is displayed as defined in the field display settings. See Managing the Cntent Type Display. Kaltura Vide Mdule fr Drupal 7.x User Manual 19

20 Additinal Integratin Pints SECTION 4 Additinal Integratin Pints This sectin describes additinal ways t integrate the Kaltura Vide Mdule t Drupal. The fllwing tpics are described: Synchrnizing the Kaltura Publisher Accunt t Drupal Editing Cntent Metadata Drupal Views Integratin Integratin with the Drupal Permissins Synchrnizing the Kaltura Publisher Accunt t Drupal There are several levels f synchrnizing yur Kaltura publisher accunt t Drupal. Autmatic server-side ntificatins Server-side ntificatins update Drupal with events ccurring in yur Kaltura accunt utside the Drupal site. These events include, fr example: New entries added Update f metadata and thumbnails f existing entries Deletin f existing entries These ntificatins are set in yur Kaltura accunt. Yu can mdify the ntificatin settings in the KMC. Fr mre infrmatin, see the Kaltura Knwledge Center article n Server Ntificatins. Scheduled Yu can add Kaltura API calls and actins n the Drupal database t a CRON jb. This ptin is fr advanced Drupal users. Cntent that is cntained in yur Kaltura accunt is the media that is synced t Drupal. Cntent that is edited (metadata) in Drupal is als synced t Kaltura. See Editing Cntent Metadata fr mre infrmatin. Anther use case, fr example, is yu may have existing cntent in yur Kaltura accunt that was upladed befre yu added the Drupal mdule and wuld like t use the cntent. Use the On-demand ptin and then turn n the autmatic prcess t ensure that all additinal cntent frm Kaltura will be upladed. T imprt cntent int Drupal using the On-demand mde 1. G t Cnfiguratin. 2. In the Media sectin, select Kaltura mdule settings and then select List f Kaltura Items tab. The list f media entries in yur Kaltura accunt that were synced already t the Drupal server are displayed. 3. At the tp click Imprt Media Entries frm Kaltura. That will start a batch peratin and imprt all entries that were nt imprted befre t Drupal. Kaltura Vide Mdule fr Drupal 7.x User Manual 20

21 Additinal Integratin Pints Editing Cntent Metadata Yu may want t edit the metadata fr cntent that yu have upladed and synced t the Drupal site. T edit cntent metadata in Drupal 1. Select the Cnfiguratin tab. 2. In the Media sectin, select Kaltura mdule settings and then select Imprting Entries frm Kaltura t Drupal tab. 3. Click n the List f Kaltura Items tab, and then click Edit Metadata. 4. Mdify the metadata infrmatin. Yu can edit the Title, Descriptin, and Tags fields, and then click Submit. The metadata is synchrnized t yur KMC cntent thrugh the Kaltura API. Drupal Views Integratin The Kaltura Mdule is fully integrated with Drupal Views. Yu can create a dynamic display f filtered Kaltura cntent using Drupal Views. Default Views are prvided with the Kaltura Mdule. The fllwing shws an example f editing a View that uses Kaltura cntent. This example is ne f the predefined views where the Filter is set t image, and the srt a criterin is set t created date. A View that cntains Kaltura cntent may als be cnfigured and displayed as a blck t allw greater design flexibility fr yur site. Kaltura Vide Mdule fr Drupal 7.x User Manual 21

22 Additinal Integratin Pints If yu extended Kaltura entity with custm fields yu can use them in Views as well. T d s, click Add field: These are cre Drupal Fields that supprt all the APIs: Integratin with Drupal Permissins Permissins let yu cntrl what users can d and see n yur site. There are fur Kaltura permissins that are integrated with the Kaltura Drupal Mdule. Administer Kaltura Access Kaltura Widgets View Kaltura embed cde Edit Kaltura Metadata Kaltura Vide Mdule fr Drupal 7.x User Manual 22

23 Additinal Integratin Pints Drupal Search Integratin In rder t include Kaltura entries int Drupal s search it is recmmended t use Search API mdule. Once install and enabled it will allw t create a new index: Yu can select which fields t index within the Search API cnfiguratin screen: All custm fields that were added t Kaltura media entity are available fr indexing as well. Kaltura Vide Mdule fr Drupal 7.x User Manual 23

24 Additinal Integratin Pints Debugging Kaltura Mdule In case yu experience any issues with the mdule please fllw these steps t ensure that the mdule was crrectly installed and cnfigured. 1. Check Status reprt page: Kaltura client library and Kaltura mdule lines shuld bth appear there in green. In case any f these lines appear with red, please fllw the guidance in the errr message and try t reslve it. Here is an example when client library wasn t setup crrectly: 2. Smetimes yu may need t clear Drupal cache befre Kaltura client library is detected, even if it s already upladed t the right directry. Yu can d s via a drush cmmand ( drush cc all ) r frm the Admin interface. 3. If yu are still experiencing trubles, check Drupal s watchdg messages lcated at /admin/reprts/dblg. It may shw useful infrmatin when there is a cnflict with anther mdule. 4. If neither f the abve helped, pen a ticket n a Drupal.rg page: Kaltura Vide Mdule fr Drupal 7.x User Manual 24