GstRtsp-1.0.gir 210 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896
  1. <?xml version="1.0"?>
  2. <!-- This file was automatically generated from C sources - DO NOT EDIT!
  3. To affect the contents of this file, edit the original C definitions,
  4. and/or use gtk-doc annotations. -->
  5. <repository version="1.2"
  6. xmlns="http://www.gtk.org/introspection/core/1.0"
  7. xmlns:c="http://www.gtk.org/introspection/c/1.0"
  8. xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
  9. <include name="Gio" version="2.0"/>
  10. <include name="Gst" version="1.0"/>
  11. <include name="GstSdp" version="1.0"/>
  12. <package name="gstreamer-rtsp-1.0"/>
  13. <c:include name="gst/rtsp/rtsp.h"/>
  14. <namespace name="GstRtsp"
  15. version="1.0"
  16. shared-library="libgstrtsp-1.0.so.0"
  17. c:identifier-prefixes="Gst"
  18. c:symbol-prefixes="gst">
  19. <enumeration name="RTSPAuthMethod"
  20. glib:type-name="GstRTSPAuthMethod"
  21. glib:get-type="gst_rtsp_auth_method_get_type"
  22. c:type="GstRTSPAuthMethod">
  23. <doc xml:space="preserve">Authentication methods, ordered by strength</doc>
  24. <member name="none"
  25. value="0"
  26. c:identifier="GST_RTSP_AUTH_NONE"
  27. glib:nick="none">
  28. <doc xml:space="preserve">no authentication</doc>
  29. </member>
  30. <member name="basic"
  31. value="1"
  32. c:identifier="GST_RTSP_AUTH_BASIC"
  33. glib:nick="basic">
  34. <doc xml:space="preserve">basic authentication</doc>
  35. </member>
  36. <member name="digest"
  37. value="2"
  38. c:identifier="GST_RTSP_AUTH_DIGEST"
  39. glib:nick="digest">
  40. <doc xml:space="preserve">digest authentication</doc>
  41. </member>
  42. </enumeration>
  43. <record name="RTSPConnection" c:type="GstRTSPConnection" disguised="1">
  44. <doc xml:space="preserve">This object manages the RTSP connection to the server. It provides function
  45. to receive and send bytes and messages.</doc>
  46. <method name="clear_auth_params"
  47. c:identifier="gst_rtsp_connection_clear_auth_params">
  48. <doc xml:space="preserve">Clear the list of authentication directives stored in @conn.</doc>
  49. <return-value transfer-ownership="none">
  50. <type name="none" c:type="void"/>
  51. </return-value>
  52. <parameters>
  53. <instance-parameter name="conn" transfer-ownership="none">
  54. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  55. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  56. </instance-parameter>
  57. </parameters>
  58. </method>
  59. <method name="close" c:identifier="gst_rtsp_connection_close">
  60. <doc xml:space="preserve">Close the connected @conn. After this call, the connection is in the same
  61. state as when it was first created.</doc>
  62. <return-value transfer-ownership="none">
  63. <doc xml:space="preserve">#GST_RTSP_OK on success.</doc>
  64. <type name="RTSPResult" c:type="GstRTSPResult"/>
  65. </return-value>
  66. <parameters>
  67. <instance-parameter name="conn" transfer-ownership="none">
  68. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  69. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  70. </instance-parameter>
  71. </parameters>
  72. </method>
  73. <method name="connect" c:identifier="gst_rtsp_connection_connect">
  74. <doc xml:space="preserve">Attempt to connect to the url of @conn made with
  75. gst_rtsp_connection_create(). If @timeout is #NULL this function can block
  76. forever. If @timeout contains a valid timeout, this function will return
  77. #GST_RTSP_ETIMEOUT after the timeout expired.
  78. This function can be cancelled with gst_rtsp_connection_flush().</doc>
  79. <return-value transfer-ownership="none">
  80. <doc xml:space="preserve">#GST_RTSP_OK when a connection could be made.</doc>
  81. <type name="RTSPResult" c:type="GstRTSPResult"/>
  82. </return-value>
  83. <parameters>
  84. <instance-parameter name="conn" transfer-ownership="none">
  85. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  86. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  87. </instance-parameter>
  88. <parameter name="timeout" transfer-ownership="none">
  89. <doc xml:space="preserve">a #GTimeVal timeout</doc>
  90. <type name="GLib.TimeVal" c:type="GTimeVal*"/>
  91. </parameter>
  92. </parameters>
  93. </method>
  94. <method name="connect_with_response"
  95. c:identifier="gst_rtsp_connection_connect_with_response">
  96. <doc xml:space="preserve">Attempt to connect to the url of @conn made with
  97. gst_rtsp_connection_create(). If @timeout is #NULL this function can block
  98. forever. If @timeout contains a valid timeout, this function will return
  99. #GST_RTSP_ETIMEOUT after the timeout expired. If @conn is set to tunneled,
  100. @response will contain a response to the tunneling request messages.
  101. This function can be cancelled with gst_rtsp_connection_flush().</doc>
  102. <return-value transfer-ownership="none">
  103. <doc xml:space="preserve">#GST_RTSP_OK when a connection could be made.
  104. Since 1.8</doc>
  105. <type name="RTSPResult" c:type="GstRTSPResult"/>
  106. </return-value>
  107. <parameters>
  108. <instance-parameter name="conn" transfer-ownership="none">
  109. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  110. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  111. </instance-parameter>
  112. <parameter name="timeout" transfer-ownership="none">
  113. <doc xml:space="preserve">a #GTimeVal timeout</doc>
  114. <type name="GLib.TimeVal" c:type="GTimeVal*"/>
  115. </parameter>
  116. <parameter name="response" transfer-ownership="none">
  117. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  118. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  119. </parameter>
  120. </parameters>
  121. </method>
  122. <method name="do_tunnel" c:identifier="gst_rtsp_connection_do_tunnel">
  123. <doc xml:space="preserve">If @conn received the first tunnel connection and @conn2 received
  124. the second tunnel connection, link the two connections together so that
  125. @conn manages the tunneled connection.
  126. After this call, @conn2 cannot be used anymore and must be freed with
  127. gst_rtsp_connection_free().
  128. If @conn2 is %NULL then only the base64 decoding context will be setup for
  129. @conn.</doc>
  130. <return-value transfer-ownership="none">
  131. <doc xml:space="preserve">return GST_RTSP_OK on success.</doc>
  132. <type name="RTSPResult" c:type="GstRTSPResult"/>
  133. </return-value>
  134. <parameters>
  135. <instance-parameter name="conn" transfer-ownership="none">
  136. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  137. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  138. </instance-parameter>
  139. <parameter name="conn2" transfer-ownership="none">
  140. <doc xml:space="preserve">a #GstRTSPConnection or %NULL</doc>
  141. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  142. </parameter>
  143. </parameters>
  144. </method>
  145. <method name="flush" c:identifier="gst_rtsp_connection_flush">
  146. <doc xml:space="preserve">Start or stop the flushing action on @conn. When flushing, all current
  147. and future actions on @conn will return #GST_RTSP_EINTR until the connection
  148. is set to non-flushing mode again.</doc>
  149. <return-value transfer-ownership="none">
  150. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  151. <type name="RTSPResult" c:type="GstRTSPResult"/>
  152. </return-value>
  153. <parameters>
  154. <instance-parameter name="conn" transfer-ownership="none">
  155. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  156. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  157. </instance-parameter>
  158. <parameter name="flush" transfer-ownership="none">
  159. <doc xml:space="preserve">start or stop the flush</doc>
  160. <type name="gboolean" c:type="gboolean"/>
  161. </parameter>
  162. </parameters>
  163. </method>
  164. <method name="free" c:identifier="gst_rtsp_connection_free">
  165. <doc xml:space="preserve">Close and free @conn.</doc>
  166. <return-value transfer-ownership="none">
  167. <doc xml:space="preserve">#GST_RTSP_OK on success.</doc>
  168. <type name="RTSPResult" c:type="GstRTSPResult"/>
  169. </return-value>
  170. <parameters>
  171. <instance-parameter name="conn" transfer-ownership="none">
  172. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  173. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  174. </instance-parameter>
  175. </parameters>
  176. </method>
  177. <method name="get_ip" c:identifier="gst_rtsp_connection_get_ip">
  178. <doc xml:space="preserve">Retrieve the IP address of the other end of @conn.</doc>
  179. <return-value transfer-ownership="none">
  180. <doc xml:space="preserve">The IP address as a string. this value remains valid until the
  181. connection is closed.</doc>
  182. <type name="utf8" c:type="const gchar*"/>
  183. </return-value>
  184. <parameters>
  185. <instance-parameter name="conn" transfer-ownership="none">
  186. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  187. <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
  188. </instance-parameter>
  189. </parameters>
  190. </method>
  191. <method name="get_read_socket"
  192. c:identifier="gst_rtsp_connection_get_read_socket">
  193. <doc xml:space="preserve">Get the file descriptor for reading.</doc>
  194. <return-value transfer-ownership="none">
  195. <doc xml:space="preserve">the file descriptor used for reading or %NULL on
  196. error. The file descriptor remains valid until the connection is closed.</doc>
  197. <type name="Gio.Socket" c:type="GSocket*"/>
  198. </return-value>
  199. <parameters>
  200. <instance-parameter name="conn" transfer-ownership="none">
  201. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  202. <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
  203. </instance-parameter>
  204. </parameters>
  205. </method>
  206. <method name="get_remember_session_id"
  207. c:identifier="gst_rtsp_connection_get_remember_session_id">
  208. <return-value transfer-ownership="none">
  209. <doc xml:space="preserve">%TRUE if the #GstRTSPConnection remembers the session id in the
  210. last response to set it on any further request.</doc>
  211. <type name="gboolean" c:type="gboolean"/>
  212. </return-value>
  213. <parameters>
  214. <instance-parameter name="conn" transfer-ownership="none">
  215. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  216. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  217. </instance-parameter>
  218. </parameters>
  219. </method>
  220. <method name="get_tls"
  221. c:identifier="gst_rtsp_connection_get_tls"
  222. version="1.2"
  223. throws="1">
  224. <doc xml:space="preserve">Get the TLS connection of @conn.
  225. For client side this will return the #GTlsClientConnection when connected
  226. over TLS.
  227. For server side connections, this function will create a GTlsServerConnection
  228. when called the first time and will return that same connection on subsequent
  229. calls. The server is then responsible for configuring the TLS connection.</doc>
  230. <return-value transfer-ownership="none">
  231. <doc xml:space="preserve">the TLS connection for @conn.</doc>
  232. <type name="Gio.TlsConnection" c:type="GTlsConnection*"/>
  233. </return-value>
  234. <parameters>
  235. <instance-parameter name="conn" transfer-ownership="none">
  236. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  237. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  238. </instance-parameter>
  239. </parameters>
  240. </method>
  241. <method name="get_tls_database"
  242. c:identifier="gst_rtsp_connection_get_tls_database"
  243. version="1.4">
  244. <doc xml:space="preserve">Gets the anchor certificate authorities database that will be used
  245. after a server certificate can't be verified with the default
  246. certificate database.</doc>
  247. <return-value transfer-ownership="full">
  248. <doc xml:space="preserve">the anchor certificate authorities database, or NULL if no
  249. database has been previously set. Use g_object_unref() to release the
  250. certificate database.</doc>
  251. <type name="Gio.TlsDatabase" c:type="GTlsDatabase*"/>
  252. </return-value>
  253. <parameters>
  254. <instance-parameter name="conn" transfer-ownership="none">
  255. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  256. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  257. </instance-parameter>
  258. </parameters>
  259. </method>
  260. <method name="get_tls_interaction"
  261. c:identifier="gst_rtsp_connection_get_tls_interaction"
  262. version="1.6">
  263. <doc xml:space="preserve">Gets a #GTlsInteraction object to be used when the connection or certificate
  264. database need to interact with the user. This will be used to prompt the
  265. user for passwords where necessary.</doc>
  266. <return-value transfer-ownership="full">
  267. <doc xml:space="preserve">a reference on the #GTlsInteraction. Use
  268. g_object_unref() to release.</doc>
  269. <type name="Gio.TlsInteraction" c:type="GTlsInteraction*"/>
  270. </return-value>
  271. <parameters>
  272. <instance-parameter name="conn" transfer-ownership="none">
  273. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  274. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  275. </instance-parameter>
  276. </parameters>
  277. </method>
  278. <method name="get_tls_validation_flags"
  279. c:identifier="gst_rtsp_connection_get_tls_validation_flags"
  280. version="1.2.1">
  281. <doc xml:space="preserve">Gets the TLS validation flags used to verify the peer certificate
  282. when a TLS connection is established.</doc>
  283. <return-value transfer-ownership="none">
  284. <doc xml:space="preserve">the validationg flags.</doc>
  285. <type name="Gio.TlsCertificateFlags" c:type="GTlsCertificateFlags"/>
  286. </return-value>
  287. <parameters>
  288. <instance-parameter name="conn" transfer-ownership="none">
  289. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  290. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  291. </instance-parameter>
  292. </parameters>
  293. </method>
  294. <method name="get_tunnelid"
  295. c:identifier="gst_rtsp_connection_get_tunnelid">
  296. <doc xml:space="preserve">Get the tunnel session id the connection.</doc>
  297. <return-value transfer-ownership="none">
  298. <doc xml:space="preserve">returns a non-empty string if @conn is being tunneled over HTTP.</doc>
  299. <type name="utf8" c:type="const gchar*"/>
  300. </return-value>
  301. <parameters>
  302. <instance-parameter name="conn" transfer-ownership="none">
  303. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  304. <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
  305. </instance-parameter>
  306. </parameters>
  307. </method>
  308. <method name="get_url" c:identifier="gst_rtsp_connection_get_url">
  309. <doc xml:space="preserve">Retrieve the URL of the other end of @conn.</doc>
  310. <return-value transfer-ownership="full">
  311. <doc xml:space="preserve">The URL. This value remains valid until the
  312. connection is freed.</doc>
  313. <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
  314. </return-value>
  315. <parameters>
  316. <instance-parameter name="conn" transfer-ownership="none">
  317. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  318. <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
  319. </instance-parameter>
  320. </parameters>
  321. </method>
  322. <method name="get_write_socket"
  323. c:identifier="gst_rtsp_connection_get_write_socket">
  324. <doc xml:space="preserve">Get the file descriptor for writing.</doc>
  325. <return-value transfer-ownership="none">
  326. <doc xml:space="preserve">the file descriptor used for writing or NULL on
  327. error. The file descriptor remains valid until the connection is closed.</doc>
  328. <type name="Gio.Socket" c:type="GSocket*"/>
  329. </return-value>
  330. <parameters>
  331. <instance-parameter name="conn" transfer-ownership="none">
  332. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  333. <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
  334. </instance-parameter>
  335. </parameters>
  336. </method>
  337. <method name="is_tunneled"
  338. c:identifier="gst_rtsp_connection_is_tunneled">
  339. <doc xml:space="preserve">Get the tunneling state of the connection.</doc>
  340. <return-value transfer-ownership="none">
  341. <doc xml:space="preserve">if @conn is using HTTP tunneling.</doc>
  342. <type name="gboolean" c:type="gboolean"/>
  343. </return-value>
  344. <parameters>
  345. <instance-parameter name="conn" transfer-ownership="none">
  346. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  347. <type name="RTSPConnection" c:type="const GstRTSPConnection*"/>
  348. </instance-parameter>
  349. </parameters>
  350. </method>
  351. <method name="next_timeout"
  352. c:identifier="gst_rtsp_connection_next_timeout">
  353. <doc xml:space="preserve">Calculate the next timeout for @conn, storing the result in @timeout.</doc>
  354. <return-value transfer-ownership="none">
  355. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  356. <type name="RTSPResult" c:type="GstRTSPResult"/>
  357. </return-value>
  358. <parameters>
  359. <instance-parameter name="conn" transfer-ownership="none">
  360. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  361. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  362. </instance-parameter>
  363. <parameter name="timeout" transfer-ownership="none">
  364. <doc xml:space="preserve">a timeout</doc>
  365. <type name="GLib.TimeVal" c:type="GTimeVal*"/>
  366. </parameter>
  367. </parameters>
  368. </method>
  369. <method name="poll" c:identifier="gst_rtsp_connection_poll">
  370. <doc xml:space="preserve">Wait up to the specified @timeout for the connection to become available for
  371. at least one of the operations specified in @events. When the function returns
  372. with #GST_RTSP_OK, @revents will contain a bitmask of available operations on
  373. @conn.
  374. @timeout can be #NULL, in which case this function might block forever.
  375. This function can be cancelled with gst_rtsp_connection_flush().</doc>
  376. <return-value transfer-ownership="none">
  377. <doc xml:space="preserve">#GST_RTSP_OK on success.</doc>
  378. <type name="RTSPResult" c:type="GstRTSPResult"/>
  379. </return-value>
  380. <parameters>
  381. <instance-parameter name="conn" transfer-ownership="none">
  382. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  383. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  384. </instance-parameter>
  385. <parameter name="events" transfer-ownership="none">
  386. <doc xml:space="preserve">a bitmask of #GstRTSPEvent flags to check</doc>
  387. <type name="RTSPEvent" c:type="GstRTSPEvent"/>
  388. </parameter>
  389. <parameter name="revents" transfer-ownership="none">
  390. <doc xml:space="preserve">location for result flags</doc>
  391. <type name="RTSPEvent" c:type="GstRTSPEvent*"/>
  392. </parameter>
  393. <parameter name="timeout" transfer-ownership="none">
  394. <doc xml:space="preserve">a timeout</doc>
  395. <type name="GLib.TimeVal" c:type="GTimeVal*"/>
  396. </parameter>
  397. </parameters>
  398. </method>
  399. <method name="read" c:identifier="gst_rtsp_connection_read">
  400. <doc xml:space="preserve">Attempt to read @size bytes into @data from the connected @conn, blocking up to
  401. the specified @timeout. @timeout can be #NULL, in which case this function
  402. might block forever.
  403. This function can be cancelled with gst_rtsp_connection_flush().</doc>
  404. <return-value transfer-ownership="none">
  405. <doc xml:space="preserve">#GST_RTSP_OK on success.</doc>
  406. <type name="RTSPResult" c:type="GstRTSPResult"/>
  407. </return-value>
  408. <parameters>
  409. <instance-parameter name="conn" transfer-ownership="none">
  410. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  411. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  412. </instance-parameter>
  413. <parameter name="data" transfer-ownership="none">
  414. <doc xml:space="preserve">the data to read</doc>
  415. <type name="guint8" c:type="guint8*"/>
  416. </parameter>
  417. <parameter name="size" transfer-ownership="none">
  418. <doc xml:space="preserve">the size of @data</doc>
  419. <type name="guint" c:type="guint"/>
  420. </parameter>
  421. <parameter name="timeout" transfer-ownership="none">
  422. <doc xml:space="preserve">a timeout value or #NULL</doc>
  423. <type name="GLib.TimeVal" c:type="GTimeVal*"/>
  424. </parameter>
  425. </parameters>
  426. </method>
  427. <method name="receive" c:identifier="gst_rtsp_connection_receive">
  428. <doc xml:space="preserve">Attempt to read into @message from the connected @conn, blocking up to
  429. the specified @timeout. @timeout can be #NULL, in which case this function
  430. might block forever.
  431. This function can be cancelled with gst_rtsp_connection_flush().</doc>
  432. <return-value transfer-ownership="none">
  433. <doc xml:space="preserve">#GST_RTSP_OK on success.</doc>
  434. <type name="RTSPResult" c:type="GstRTSPResult"/>
  435. </return-value>
  436. <parameters>
  437. <instance-parameter name="conn" transfer-ownership="none">
  438. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  439. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  440. </instance-parameter>
  441. <parameter name="message" transfer-ownership="none">
  442. <doc xml:space="preserve">the message to read</doc>
  443. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  444. </parameter>
  445. <parameter name="timeout" transfer-ownership="none">
  446. <doc xml:space="preserve">a timeout value or #NULL</doc>
  447. <type name="GLib.TimeVal" c:type="GTimeVal*"/>
  448. </parameter>
  449. </parameters>
  450. </method>
  451. <method name="reset_timeout"
  452. c:identifier="gst_rtsp_connection_reset_timeout">
  453. <doc xml:space="preserve">Reset the timeout of @conn.</doc>
  454. <return-value transfer-ownership="none">
  455. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  456. <type name="RTSPResult" c:type="GstRTSPResult"/>
  457. </return-value>
  458. <parameters>
  459. <instance-parameter name="conn" transfer-ownership="none">
  460. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  461. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  462. </instance-parameter>
  463. </parameters>
  464. </method>
  465. <method name="send" c:identifier="gst_rtsp_connection_send">
  466. <doc xml:space="preserve">Attempt to send @message to the connected @conn, blocking up to
  467. the specified @timeout. @timeout can be #NULL, in which case this function
  468. might block forever.
  469. This function can be cancelled with gst_rtsp_connection_flush().</doc>
  470. <return-value transfer-ownership="none">
  471. <doc xml:space="preserve">#GST_RTSP_OK on success.</doc>
  472. <type name="RTSPResult" c:type="GstRTSPResult"/>
  473. </return-value>
  474. <parameters>
  475. <instance-parameter name="conn" transfer-ownership="none">
  476. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  477. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  478. </instance-parameter>
  479. <parameter name="message" transfer-ownership="none">
  480. <doc xml:space="preserve">the message to send</doc>
  481. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  482. </parameter>
  483. <parameter name="timeout" transfer-ownership="none">
  484. <doc xml:space="preserve">a timeout value or #NULL</doc>
  485. <type name="GLib.TimeVal" c:type="GTimeVal*"/>
  486. </parameter>
  487. </parameters>
  488. </method>
  489. <method name="set_auth" c:identifier="gst_rtsp_connection_set_auth">
  490. <doc xml:space="preserve">Configure @conn for authentication mode @method with @user and @pass as the
  491. user and password respectively.</doc>
  492. <return-value transfer-ownership="none">
  493. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  494. <type name="RTSPResult" c:type="GstRTSPResult"/>
  495. </return-value>
  496. <parameters>
  497. <instance-parameter name="conn" transfer-ownership="none">
  498. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  499. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  500. </instance-parameter>
  501. <parameter name="method" transfer-ownership="none">
  502. <doc xml:space="preserve">authentication method</doc>
  503. <type name="RTSPAuthMethod" c:type="GstRTSPAuthMethod"/>
  504. </parameter>
  505. <parameter name="user" transfer-ownership="none">
  506. <doc xml:space="preserve">the user</doc>
  507. <type name="utf8" c:type="const gchar*"/>
  508. </parameter>
  509. <parameter name="pass" transfer-ownership="none">
  510. <doc xml:space="preserve">the password</doc>
  511. <type name="utf8" c:type="const gchar*"/>
  512. </parameter>
  513. </parameters>
  514. </method>
  515. <method name="set_auth_param"
  516. c:identifier="gst_rtsp_connection_set_auth_param">
  517. <doc xml:space="preserve">Setup @conn with authentication directives. This is not necesary for
  518. methods #GST_RTSP_AUTH_NONE and #GST_RTSP_AUTH_BASIC. For
  519. #GST_RTSP_AUTH_DIGEST, directives should be taken from the digest challenge
  520. in the WWW-Authenticate response header and can include realm, domain,
  521. nonce, opaque, stale, algorithm, qop as per RFC2617.</doc>
  522. <return-value transfer-ownership="none">
  523. <type name="none" c:type="void"/>
  524. </return-value>
  525. <parameters>
  526. <instance-parameter name="conn" transfer-ownership="none">
  527. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  528. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  529. </instance-parameter>
  530. <parameter name="param" transfer-ownership="none">
  531. <doc xml:space="preserve">authentication directive</doc>
  532. <type name="utf8" c:type="const gchar*"/>
  533. </parameter>
  534. <parameter name="value" transfer-ownership="none">
  535. <doc xml:space="preserve">value</doc>
  536. <type name="utf8" c:type="const gchar*"/>
  537. </parameter>
  538. </parameters>
  539. </method>
  540. <method name="set_http_mode"
  541. c:identifier="gst_rtsp_connection_set_http_mode">
  542. <doc xml:space="preserve">By setting the HTTP mode to %TRUE the message parsing will support HTTP
  543. messages in addition to the RTSP messages. It will also disable the
  544. automatic handling of setting up an HTTP tunnel.</doc>
  545. <return-value transfer-ownership="none">
  546. <type name="none" c:type="void"/>
  547. </return-value>
  548. <parameters>
  549. <instance-parameter name="conn" transfer-ownership="none">
  550. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  551. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  552. </instance-parameter>
  553. <parameter name="enable" transfer-ownership="none">
  554. <doc xml:space="preserve">%TRUE to enable manual HTTP mode</doc>
  555. <type name="gboolean" c:type="gboolean"/>
  556. </parameter>
  557. </parameters>
  558. </method>
  559. <method name="set_ip" c:identifier="gst_rtsp_connection_set_ip">
  560. <doc xml:space="preserve">Set the IP address of the server.</doc>
  561. <return-value transfer-ownership="none">
  562. <type name="none" c:type="void"/>
  563. </return-value>
  564. <parameters>
  565. <instance-parameter name="conn" transfer-ownership="none">
  566. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  567. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  568. </instance-parameter>
  569. <parameter name="ip" transfer-ownership="none">
  570. <doc xml:space="preserve">an ip address</doc>
  571. <type name="utf8" c:type="const gchar*"/>
  572. </parameter>
  573. </parameters>
  574. </method>
  575. <method name="set_proxy" c:identifier="gst_rtsp_connection_set_proxy">
  576. <doc xml:space="preserve">Set the proxy host and port.</doc>
  577. <return-value transfer-ownership="none">
  578. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  579. <type name="RTSPResult" c:type="GstRTSPResult"/>
  580. </return-value>
  581. <parameters>
  582. <instance-parameter name="conn" transfer-ownership="none">
  583. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  584. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  585. </instance-parameter>
  586. <parameter name="host" transfer-ownership="none">
  587. <doc xml:space="preserve">the proxy host</doc>
  588. <type name="utf8" c:type="const gchar*"/>
  589. </parameter>
  590. <parameter name="port" transfer-ownership="none">
  591. <doc xml:space="preserve">the proxy port</doc>
  592. <type name="guint" c:type="guint"/>
  593. </parameter>
  594. </parameters>
  595. </method>
  596. <method name="set_qos_dscp"
  597. c:identifier="gst_rtsp_connection_set_qos_dscp">
  598. <doc xml:space="preserve">Configure @conn to use the specified DSCP value.</doc>
  599. <return-value transfer-ownership="none">
  600. <doc xml:space="preserve">#GST_RTSP_OK on success.</doc>
  601. <type name="RTSPResult" c:type="GstRTSPResult"/>
  602. </return-value>
  603. <parameters>
  604. <instance-parameter name="conn" transfer-ownership="none">
  605. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  606. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  607. </instance-parameter>
  608. <parameter name="qos_dscp" transfer-ownership="none">
  609. <doc xml:space="preserve">DSCP value</doc>
  610. <type name="guint" c:type="guint"/>
  611. </parameter>
  612. </parameters>
  613. </method>
  614. <method name="set_remember_session_id"
  615. c:identifier="gst_rtsp_connection_set_remember_session_id">
  616. <doc xml:space="preserve">Sets if the #GstRTSPConnection should remember the session id from the last
  617. response received and force it onto any further requests.
  618. The default value is %TRUE</doc>
  619. <return-value transfer-ownership="none">
  620. <type name="none" c:type="void"/>
  621. </return-value>
  622. <parameters>
  623. <instance-parameter name="conn" transfer-ownership="none">
  624. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  625. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  626. </instance-parameter>
  627. <parameter name="remember" transfer-ownership="none">
  628. <doc xml:space="preserve">%TRUE if the connection should remember the session id</doc>
  629. <type name="gboolean" c:type="gboolean"/>
  630. </parameter>
  631. </parameters>
  632. </method>
  633. <method name="set_tls_database"
  634. c:identifier="gst_rtsp_connection_set_tls_database"
  635. version="1.4">
  636. <doc xml:space="preserve">Sets the anchor certificate authorities database. This certificate
  637. database will be used to verify the server's certificate in case it
  638. can't be verified with the default certificate database first.</doc>
  639. <return-value transfer-ownership="none">
  640. <type name="none" c:type="void"/>
  641. </return-value>
  642. <parameters>
  643. <instance-parameter name="conn" transfer-ownership="none">
  644. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  645. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  646. </instance-parameter>
  647. <parameter name="database" transfer-ownership="none">
  648. <doc xml:space="preserve">a #GTlsDatabase</doc>
  649. <type name="Gio.TlsDatabase" c:type="GTlsDatabase*"/>
  650. </parameter>
  651. </parameters>
  652. </method>
  653. <method name="set_tls_interaction"
  654. c:identifier="gst_rtsp_connection_set_tls_interaction"
  655. version="1.6">
  656. <doc xml:space="preserve">Sets a #GTlsInteraction object to be used when the connection or certificate
  657. database need to interact with the user. This will be used to prompt the
  658. user for passwords where necessary.</doc>
  659. <return-value transfer-ownership="none">
  660. <type name="none" c:type="void"/>
  661. </return-value>
  662. <parameters>
  663. <instance-parameter name="conn" transfer-ownership="none">
  664. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  665. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  666. </instance-parameter>
  667. <parameter name="interaction" transfer-ownership="none">
  668. <doc xml:space="preserve">a #GTlsInteraction</doc>
  669. <type name="Gio.TlsInteraction" c:type="GTlsInteraction*"/>
  670. </parameter>
  671. </parameters>
  672. </method>
  673. <method name="set_tls_validation_flags"
  674. c:identifier="gst_rtsp_connection_set_tls_validation_flags"
  675. version="1.2.1">
  676. <doc xml:space="preserve">Sets the TLS validation flags to be used to verify the peer
  677. certificate when a TLS connection is established.</doc>
  678. <return-value transfer-ownership="none">
  679. <doc xml:space="preserve">TRUE if the validation flags are set correctly, or FALSE if
  680. @conn is NULL or is not a TLS connection.</doc>
  681. <type name="gboolean" c:type="gboolean"/>
  682. </return-value>
  683. <parameters>
  684. <instance-parameter name="conn" transfer-ownership="none">
  685. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  686. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  687. </instance-parameter>
  688. <parameter name="flags" transfer-ownership="none">
  689. <doc xml:space="preserve">the validation flags.</doc>
  690. <type name="Gio.TlsCertificateFlags"
  691. c:type="GTlsCertificateFlags"/>
  692. </parameter>
  693. </parameters>
  694. </method>
  695. <method name="set_tunneled"
  696. c:identifier="gst_rtsp_connection_set_tunneled">
  697. <doc xml:space="preserve">Set the HTTP tunneling state of the connection. This must be configured before
  698. the @conn is connected.</doc>
  699. <return-value transfer-ownership="none">
  700. <type name="none" c:type="void"/>
  701. </return-value>
  702. <parameters>
  703. <instance-parameter name="conn" transfer-ownership="none">
  704. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  705. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  706. </instance-parameter>
  707. <parameter name="tunneled" transfer-ownership="none">
  708. <doc xml:space="preserve">the new state</doc>
  709. <type name="gboolean" c:type="gboolean"/>
  710. </parameter>
  711. </parameters>
  712. </method>
  713. <method name="write" c:identifier="gst_rtsp_connection_write">
  714. <doc xml:space="preserve">Attempt to write @size bytes of @data to the connected @conn, blocking up to
  715. the specified @timeout. @timeout can be #NULL, in which case this function
  716. might block forever.
  717. This function can be cancelled with gst_rtsp_connection_flush().</doc>
  718. <return-value transfer-ownership="none">
  719. <doc xml:space="preserve">#GST_RTSP_OK on success.</doc>
  720. <type name="RTSPResult" c:type="GstRTSPResult"/>
  721. </return-value>
  722. <parameters>
  723. <instance-parameter name="conn" transfer-ownership="none">
  724. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  725. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  726. </instance-parameter>
  727. <parameter name="data" transfer-ownership="none">
  728. <doc xml:space="preserve">the data to write</doc>
  729. <type name="guint8" c:type="const guint8*"/>
  730. </parameter>
  731. <parameter name="size" transfer-ownership="none">
  732. <doc xml:space="preserve">the size of @data</doc>
  733. <type name="guint" c:type="guint"/>
  734. </parameter>
  735. <parameter name="timeout" transfer-ownership="none">
  736. <doc xml:space="preserve">a timeout value or #NULL</doc>
  737. <type name="GLib.TimeVal" c:type="GTimeVal*"/>
  738. </parameter>
  739. </parameters>
  740. </method>
  741. <function name="accept" c:identifier="gst_rtsp_connection_accept">
  742. <doc xml:space="preserve">Accept a new connection on @socket and create a new #GstRTSPConnection for
  743. handling communication on new socket.</doc>
  744. <return-value transfer-ownership="none">
  745. <doc xml:space="preserve">#GST_RTSP_OK when @conn contains a valid connection.</doc>
  746. <type name="RTSPResult" c:type="GstRTSPResult"/>
  747. </return-value>
  748. <parameters>
  749. <parameter name="socket" transfer-ownership="none">
  750. <doc xml:space="preserve">a socket</doc>
  751. <type name="Gio.Socket" c:type="GSocket*"/>
  752. </parameter>
  753. <parameter name="conn"
  754. direction="out"
  755. caller-allocates="0"
  756. transfer-ownership="full">
  757. <doc xml:space="preserve">storage for a #GstRTSPConnection</doc>
  758. <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
  759. </parameter>
  760. <parameter name="cancellable"
  761. transfer-ownership="none"
  762. nullable="1"
  763. allow-none="1">
  764. <doc xml:space="preserve">a #GCancellable to cancel the operation</doc>
  765. <type name="Gio.Cancellable" c:type="GCancellable*"/>
  766. </parameter>
  767. </parameters>
  768. </function>
  769. <function name="create" c:identifier="gst_rtsp_connection_create">
  770. <doc xml:space="preserve">Create a newly allocated #GstRTSPConnection from @url and store it in @conn.
  771. The connection will not yet attempt to connect to @url, use
  772. gst_rtsp_connection_connect().
  773. A copy of @url will be made.</doc>
  774. <return-value transfer-ownership="none">
  775. <doc xml:space="preserve">#GST_RTSP_OK when @conn contains a valid connection.</doc>
  776. <type name="RTSPResult" c:type="GstRTSPResult"/>
  777. </return-value>
  778. <parameters>
  779. <parameter name="url" transfer-ownership="none">
  780. <doc xml:space="preserve">a #GstRTSPUrl</doc>
  781. <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
  782. </parameter>
  783. <parameter name="conn"
  784. direction="out"
  785. caller-allocates="0"
  786. transfer-ownership="full">
  787. <doc xml:space="preserve">storage for a #GstRTSPConnection</doc>
  788. <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
  789. </parameter>
  790. </parameters>
  791. </function>
  792. <function name="create_from_socket"
  793. c:identifier="gst_rtsp_connection_create_from_socket">
  794. <doc xml:space="preserve">Create a new #GstRTSPConnection for handling communication on the existing
  795. socket @socket. The @initial_buffer contains zero terminated data already
  796. read from @socket which should be used before starting to read new data.</doc>
  797. <return-value transfer-ownership="none">
  798. <doc xml:space="preserve">#GST_RTSP_OK when @conn contains a valid connection.</doc>
  799. <type name="RTSPResult" c:type="GstRTSPResult"/>
  800. </return-value>
  801. <parameters>
  802. <parameter name="socket" transfer-ownership="none">
  803. <doc xml:space="preserve">a #GSocket</doc>
  804. <type name="Gio.Socket" c:type="GSocket*"/>
  805. </parameter>
  806. <parameter name="ip" transfer-ownership="none">
  807. <doc xml:space="preserve">the IP address of the other end</doc>
  808. <type name="utf8" c:type="const gchar*"/>
  809. </parameter>
  810. <parameter name="port" transfer-ownership="none">
  811. <doc xml:space="preserve">the port used by the other end</doc>
  812. <type name="guint16" c:type="guint16"/>
  813. </parameter>
  814. <parameter name="initial_buffer" transfer-ownership="none">
  815. <doc xml:space="preserve">data already read from @fd</doc>
  816. <type name="utf8" c:type="const gchar*"/>
  817. </parameter>
  818. <parameter name="conn"
  819. direction="out"
  820. caller-allocates="0"
  821. transfer-ownership="full">
  822. <doc xml:space="preserve">storage for a #GstRTSPConnection</doc>
  823. <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
  824. </parameter>
  825. </parameters>
  826. </function>
  827. </record>
  828. <bitfield name="RTSPEvent"
  829. glib:type-name="GstRTSPEvent"
  830. glib:get-type="gst_rtsp_event_get_type"
  831. c:type="GstRTSPEvent">
  832. <doc xml:space="preserve">The possible events for the connection.</doc>
  833. <member name="read"
  834. value="1"
  835. c:identifier="GST_RTSP_EV_READ"
  836. glib:nick="read">
  837. <doc xml:space="preserve">connection is readable</doc>
  838. </member>
  839. <member name="write"
  840. value="2"
  841. c:identifier="GST_RTSP_EV_WRITE"
  842. glib:nick="write">
  843. <doc xml:space="preserve">connection is writable</doc>
  844. </member>
  845. </bitfield>
  846. <interface name="RTSPExtension"
  847. c:symbol-prefix="rtsp_extension"
  848. c:type="GstRTSPExtension"
  849. glib:type-name="GstRTSPExtension"
  850. glib:get-type="gst_rtsp_extension_get_type"
  851. glib:type-struct="RTSPExtensionInterface">
  852. <doc xml:space="preserve">&lt;refsect2&gt;
  853. &lt;para&gt;
  854. This interface is implemented e.g. by the Windows Media Streaming RTSP
  855. exentension (rtspwms) and the RealMedia RTSP extension (rtspreal).
  856. &lt;/para&gt;
  857. &lt;/refsect2&gt;</doc>
  858. <virtual-method name="after_send" invoker="after_send">
  859. <return-value transfer-ownership="none">
  860. <type name="RTSPResult" c:type="GstRTSPResult"/>
  861. </return-value>
  862. <parameters>
  863. <instance-parameter name="ext" transfer-ownership="none">
  864. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  865. </instance-parameter>
  866. <parameter name="req" transfer-ownership="none">
  867. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  868. </parameter>
  869. <parameter name="resp" transfer-ownership="none">
  870. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  871. </parameter>
  872. </parameters>
  873. </virtual-method>
  874. <virtual-method name="before_send" invoker="before_send">
  875. <return-value transfer-ownership="none">
  876. <type name="RTSPResult" c:type="GstRTSPResult"/>
  877. </return-value>
  878. <parameters>
  879. <instance-parameter name="ext" transfer-ownership="none">
  880. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  881. </instance-parameter>
  882. <parameter name="req" transfer-ownership="none">
  883. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  884. </parameter>
  885. </parameters>
  886. </virtual-method>
  887. <virtual-method name="configure_stream" invoker="configure_stream">
  888. <return-value transfer-ownership="none">
  889. <type name="gboolean" c:type="gboolean"/>
  890. </return-value>
  891. <parameters>
  892. <instance-parameter name="ext" transfer-ownership="none">
  893. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  894. </instance-parameter>
  895. <parameter name="caps" transfer-ownership="none">
  896. <type name="Gst.Caps" c:type="GstCaps*"/>
  897. </parameter>
  898. </parameters>
  899. </virtual-method>
  900. <virtual-method name="detect_server" invoker="detect_server">
  901. <return-value transfer-ownership="none">
  902. <type name="gboolean" c:type="gboolean"/>
  903. </return-value>
  904. <parameters>
  905. <instance-parameter name="ext" transfer-ownership="none">
  906. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  907. </instance-parameter>
  908. <parameter name="resp" transfer-ownership="none">
  909. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  910. </parameter>
  911. </parameters>
  912. </virtual-method>
  913. <virtual-method name="get_transports" invoker="get_transports">
  914. <return-value transfer-ownership="none">
  915. <type name="RTSPResult" c:type="GstRTSPResult"/>
  916. </return-value>
  917. <parameters>
  918. <instance-parameter name="ext" transfer-ownership="none">
  919. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  920. </instance-parameter>
  921. <parameter name="protocols" transfer-ownership="none">
  922. <type name="RTSPLowerTrans" c:type="GstRTSPLowerTrans"/>
  923. </parameter>
  924. <parameter name="transport" transfer-ownership="none">
  925. <type name="utf8" c:type="gchar**"/>
  926. </parameter>
  927. </parameters>
  928. </virtual-method>
  929. <virtual-method name="parse_sdp" invoker="parse_sdp">
  930. <return-value transfer-ownership="none">
  931. <type name="RTSPResult" c:type="GstRTSPResult"/>
  932. </return-value>
  933. <parameters>
  934. <instance-parameter name="ext" transfer-ownership="none">
  935. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  936. </instance-parameter>
  937. <parameter name="sdp" transfer-ownership="none">
  938. <type name="GstSdp.SDPMessage" c:type="GstSDPMessage*"/>
  939. </parameter>
  940. <parameter name="s" transfer-ownership="none">
  941. <type name="Gst.Structure" c:type="GstStructure*"/>
  942. </parameter>
  943. </parameters>
  944. </virtual-method>
  945. <virtual-method name="receive_request" invoker="receive_request">
  946. <return-value transfer-ownership="none">
  947. <type name="RTSPResult" c:type="GstRTSPResult"/>
  948. </return-value>
  949. <parameters>
  950. <instance-parameter name="ext" transfer-ownership="none">
  951. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  952. </instance-parameter>
  953. <parameter name="req" transfer-ownership="none">
  954. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  955. </parameter>
  956. </parameters>
  957. </virtual-method>
  958. <virtual-method name="send" invoker="send">
  959. <return-value transfer-ownership="none">
  960. <type name="RTSPResult" c:type="GstRTSPResult"/>
  961. </return-value>
  962. <parameters>
  963. <instance-parameter name="ext" transfer-ownership="none">
  964. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  965. </instance-parameter>
  966. <parameter name="req" transfer-ownership="none">
  967. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  968. </parameter>
  969. <parameter name="resp" transfer-ownership="none">
  970. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  971. </parameter>
  972. </parameters>
  973. </virtual-method>
  974. <virtual-method name="setup_media" invoker="setup_media">
  975. <return-value transfer-ownership="none">
  976. <type name="RTSPResult" c:type="GstRTSPResult"/>
  977. </return-value>
  978. <parameters>
  979. <instance-parameter name="ext" transfer-ownership="none">
  980. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  981. </instance-parameter>
  982. <parameter name="media" transfer-ownership="none">
  983. <type name="GstSdp.SDPMedia" c:type="GstSDPMedia*"/>
  984. </parameter>
  985. </parameters>
  986. </virtual-method>
  987. <virtual-method name="stream_select" invoker="stream_select">
  988. <return-value transfer-ownership="none">
  989. <type name="RTSPResult" c:type="GstRTSPResult"/>
  990. </return-value>
  991. <parameters>
  992. <instance-parameter name="ext" transfer-ownership="none">
  993. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  994. </instance-parameter>
  995. <parameter name="url" transfer-ownership="none">
  996. <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
  997. </parameter>
  998. </parameters>
  999. </virtual-method>
  1000. <method name="after_send" c:identifier="gst_rtsp_extension_after_send">
  1001. <return-value transfer-ownership="none">
  1002. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1003. </return-value>
  1004. <parameters>
  1005. <instance-parameter name="ext" transfer-ownership="none">
  1006. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1007. </instance-parameter>
  1008. <parameter name="req" transfer-ownership="none">
  1009. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1010. </parameter>
  1011. <parameter name="resp" transfer-ownership="none">
  1012. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1013. </parameter>
  1014. </parameters>
  1015. </method>
  1016. <method name="before_send" c:identifier="gst_rtsp_extension_before_send">
  1017. <return-value transfer-ownership="none">
  1018. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1019. </return-value>
  1020. <parameters>
  1021. <instance-parameter name="ext" transfer-ownership="none">
  1022. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1023. </instance-parameter>
  1024. <parameter name="req" transfer-ownership="none">
  1025. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1026. </parameter>
  1027. </parameters>
  1028. </method>
  1029. <method name="configure_stream"
  1030. c:identifier="gst_rtsp_extension_configure_stream">
  1031. <return-value transfer-ownership="none">
  1032. <type name="gboolean" c:type="gboolean"/>
  1033. </return-value>
  1034. <parameters>
  1035. <instance-parameter name="ext" transfer-ownership="none">
  1036. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1037. </instance-parameter>
  1038. <parameter name="caps" transfer-ownership="none">
  1039. <type name="Gst.Caps" c:type="GstCaps*"/>
  1040. </parameter>
  1041. </parameters>
  1042. </method>
  1043. <method name="detect_server"
  1044. c:identifier="gst_rtsp_extension_detect_server">
  1045. <return-value transfer-ownership="none">
  1046. <type name="gboolean" c:type="gboolean"/>
  1047. </return-value>
  1048. <parameters>
  1049. <instance-parameter name="ext" transfer-ownership="none">
  1050. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1051. </instance-parameter>
  1052. <parameter name="resp" transfer-ownership="none">
  1053. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1054. </parameter>
  1055. </parameters>
  1056. </method>
  1057. <method name="get_transports"
  1058. c:identifier="gst_rtsp_extension_get_transports">
  1059. <return-value transfer-ownership="none">
  1060. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1061. </return-value>
  1062. <parameters>
  1063. <instance-parameter name="ext" transfer-ownership="none">
  1064. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1065. </instance-parameter>
  1066. <parameter name="protocols" transfer-ownership="none">
  1067. <type name="RTSPLowerTrans" c:type="GstRTSPLowerTrans"/>
  1068. </parameter>
  1069. <parameter name="transport" transfer-ownership="none">
  1070. <type name="utf8" c:type="gchar**"/>
  1071. </parameter>
  1072. </parameters>
  1073. </method>
  1074. <method name="parse_sdp" c:identifier="gst_rtsp_extension_parse_sdp">
  1075. <return-value transfer-ownership="none">
  1076. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1077. </return-value>
  1078. <parameters>
  1079. <instance-parameter name="ext" transfer-ownership="none">
  1080. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1081. </instance-parameter>
  1082. <parameter name="sdp" transfer-ownership="none">
  1083. <type name="GstSdp.SDPMessage" c:type="GstSDPMessage*"/>
  1084. </parameter>
  1085. <parameter name="s" transfer-ownership="none">
  1086. <type name="Gst.Structure" c:type="GstStructure*"/>
  1087. </parameter>
  1088. </parameters>
  1089. </method>
  1090. <method name="receive_request"
  1091. c:identifier="gst_rtsp_extension_receive_request">
  1092. <return-value transfer-ownership="none">
  1093. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1094. </return-value>
  1095. <parameters>
  1096. <instance-parameter name="ext" transfer-ownership="none">
  1097. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1098. </instance-parameter>
  1099. <parameter name="req" transfer-ownership="none">
  1100. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1101. </parameter>
  1102. </parameters>
  1103. </method>
  1104. <method name="send" c:identifier="gst_rtsp_extension_send">
  1105. <return-value transfer-ownership="none">
  1106. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1107. </return-value>
  1108. <parameters>
  1109. <instance-parameter name="ext" transfer-ownership="none">
  1110. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1111. </instance-parameter>
  1112. <parameter name="req" transfer-ownership="none">
  1113. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1114. </parameter>
  1115. <parameter name="resp" transfer-ownership="none">
  1116. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1117. </parameter>
  1118. </parameters>
  1119. </method>
  1120. <method name="setup_media" c:identifier="gst_rtsp_extension_setup_media">
  1121. <return-value transfer-ownership="none">
  1122. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1123. </return-value>
  1124. <parameters>
  1125. <instance-parameter name="ext" transfer-ownership="none">
  1126. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1127. </instance-parameter>
  1128. <parameter name="media" transfer-ownership="none">
  1129. <type name="GstSdp.SDPMedia" c:type="GstSDPMedia*"/>
  1130. </parameter>
  1131. </parameters>
  1132. </method>
  1133. <method name="stream_select"
  1134. c:identifier="gst_rtsp_extension_stream_select">
  1135. <return-value transfer-ownership="none">
  1136. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1137. </return-value>
  1138. <parameters>
  1139. <instance-parameter name="ext" transfer-ownership="none">
  1140. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1141. </instance-parameter>
  1142. <parameter name="url" transfer-ownership="none">
  1143. <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
  1144. </parameter>
  1145. </parameters>
  1146. </method>
  1147. <glib:signal name="send" when="last">
  1148. <return-value transfer-ownership="none">
  1149. <type name="RTSPResult"/>
  1150. </return-value>
  1151. <parameters>
  1152. <parameter name="object"
  1153. transfer-ownership="none"
  1154. nullable="1"
  1155. allow-none="1">
  1156. <type name="gpointer" c:type="gpointer"/>
  1157. </parameter>
  1158. <parameter name="p0"
  1159. transfer-ownership="none"
  1160. nullable="1"
  1161. allow-none="1">
  1162. <type name="gpointer" c:type="gpointer"/>
  1163. </parameter>
  1164. </parameters>
  1165. </glib:signal>
  1166. </interface>
  1167. <record name="RTSPExtensionInterface"
  1168. c:type="GstRTSPExtensionInterface"
  1169. glib:is-gtype-struct-for="RTSPExtension">
  1170. <field name="parent">
  1171. <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
  1172. </field>
  1173. <field name="detect_server">
  1174. <callback name="detect_server">
  1175. <return-value transfer-ownership="none">
  1176. <type name="gboolean" c:type="gboolean"/>
  1177. </return-value>
  1178. <parameters>
  1179. <parameter name="ext" transfer-ownership="none">
  1180. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1181. </parameter>
  1182. <parameter name="resp" transfer-ownership="none">
  1183. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1184. </parameter>
  1185. </parameters>
  1186. </callback>
  1187. </field>
  1188. <field name="before_send">
  1189. <callback name="before_send">
  1190. <return-value transfer-ownership="none">
  1191. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1192. </return-value>
  1193. <parameters>
  1194. <parameter name="ext" transfer-ownership="none">
  1195. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1196. </parameter>
  1197. <parameter name="req" transfer-ownership="none">
  1198. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1199. </parameter>
  1200. </parameters>
  1201. </callback>
  1202. </field>
  1203. <field name="after_send">
  1204. <callback name="after_send">
  1205. <return-value transfer-ownership="none">
  1206. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1207. </return-value>
  1208. <parameters>
  1209. <parameter name="ext" transfer-ownership="none">
  1210. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1211. </parameter>
  1212. <parameter name="req" transfer-ownership="none">
  1213. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1214. </parameter>
  1215. <parameter name="resp" transfer-ownership="none">
  1216. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1217. </parameter>
  1218. </parameters>
  1219. </callback>
  1220. </field>
  1221. <field name="parse_sdp">
  1222. <callback name="parse_sdp">
  1223. <return-value transfer-ownership="none">
  1224. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1225. </return-value>
  1226. <parameters>
  1227. <parameter name="ext" transfer-ownership="none">
  1228. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1229. </parameter>
  1230. <parameter name="sdp" transfer-ownership="none">
  1231. <type name="GstSdp.SDPMessage" c:type="GstSDPMessage*"/>
  1232. </parameter>
  1233. <parameter name="s" transfer-ownership="none">
  1234. <type name="Gst.Structure" c:type="GstStructure*"/>
  1235. </parameter>
  1236. </parameters>
  1237. </callback>
  1238. </field>
  1239. <field name="setup_media">
  1240. <callback name="setup_media">
  1241. <return-value transfer-ownership="none">
  1242. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1243. </return-value>
  1244. <parameters>
  1245. <parameter name="ext" transfer-ownership="none">
  1246. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1247. </parameter>
  1248. <parameter name="media" transfer-ownership="none">
  1249. <type name="GstSdp.SDPMedia" c:type="GstSDPMedia*"/>
  1250. </parameter>
  1251. </parameters>
  1252. </callback>
  1253. </field>
  1254. <field name="configure_stream">
  1255. <callback name="configure_stream">
  1256. <return-value transfer-ownership="none">
  1257. <type name="gboolean" c:type="gboolean"/>
  1258. </return-value>
  1259. <parameters>
  1260. <parameter name="ext" transfer-ownership="none">
  1261. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1262. </parameter>
  1263. <parameter name="caps" transfer-ownership="none">
  1264. <type name="Gst.Caps" c:type="GstCaps*"/>
  1265. </parameter>
  1266. </parameters>
  1267. </callback>
  1268. </field>
  1269. <field name="get_transports">
  1270. <callback name="get_transports">
  1271. <return-value transfer-ownership="none">
  1272. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1273. </return-value>
  1274. <parameters>
  1275. <parameter name="ext" transfer-ownership="none">
  1276. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1277. </parameter>
  1278. <parameter name="protocols" transfer-ownership="none">
  1279. <type name="RTSPLowerTrans" c:type="GstRTSPLowerTrans"/>
  1280. </parameter>
  1281. <parameter name="transport" transfer-ownership="none">
  1282. <type name="utf8" c:type="gchar**"/>
  1283. </parameter>
  1284. </parameters>
  1285. </callback>
  1286. </field>
  1287. <field name="stream_select">
  1288. <callback name="stream_select">
  1289. <return-value transfer-ownership="none">
  1290. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1291. </return-value>
  1292. <parameters>
  1293. <parameter name="ext" transfer-ownership="none">
  1294. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1295. </parameter>
  1296. <parameter name="url" transfer-ownership="none">
  1297. <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
  1298. </parameter>
  1299. </parameters>
  1300. </callback>
  1301. </field>
  1302. <field name="send">
  1303. <callback name="send">
  1304. <return-value transfer-ownership="none">
  1305. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1306. </return-value>
  1307. <parameters>
  1308. <parameter name="ext" transfer-ownership="none">
  1309. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1310. </parameter>
  1311. <parameter name="req" transfer-ownership="none">
  1312. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1313. </parameter>
  1314. <parameter name="resp" transfer-ownership="none">
  1315. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1316. </parameter>
  1317. </parameters>
  1318. </callback>
  1319. </field>
  1320. <field name="receive_request">
  1321. <callback name="receive_request">
  1322. <return-value transfer-ownership="none">
  1323. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1324. </return-value>
  1325. <parameters>
  1326. <parameter name="ext" transfer-ownership="none">
  1327. <type name="RTSPExtension" c:type="GstRTSPExtension*"/>
  1328. </parameter>
  1329. <parameter name="req" transfer-ownership="none">
  1330. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1331. </parameter>
  1332. </parameters>
  1333. </callback>
  1334. </field>
  1335. <field name="_gst_reserved" readable="0" private="1">
  1336. <array zero-terminated="0" c:type="gpointer" fixed-size="4">
  1337. <type name="gpointer" c:type="gpointer"/>
  1338. </array>
  1339. </field>
  1340. </record>
  1341. <enumeration name="RTSPFamily"
  1342. glib:type-name="GstRTSPFamily"
  1343. glib:get-type="gst_rtsp_family_get_type"
  1344. c:type="GstRTSPFamily">
  1345. <doc xml:space="preserve">The possible network families.</doc>
  1346. <member name="none"
  1347. value="0"
  1348. c:identifier="GST_RTSP_FAM_NONE"
  1349. glib:nick="none">
  1350. <doc xml:space="preserve">unknown network family</doc>
  1351. </member>
  1352. <member name="inet"
  1353. value="1"
  1354. c:identifier="GST_RTSP_FAM_INET"
  1355. glib:nick="inet">
  1356. <doc xml:space="preserve">internet</doc>
  1357. </member>
  1358. <member name="inet6"
  1359. value="2"
  1360. c:identifier="GST_RTSP_FAM_INET6"
  1361. glib:nick="inet6">
  1362. <doc xml:space="preserve">internet V6</doc>
  1363. </member>
  1364. </enumeration>
  1365. <enumeration name="RTSPHeaderField"
  1366. glib:type-name="GstRTSPHeaderField"
  1367. glib:get-type="gst_rtsp_header_field_get_type"
  1368. c:type="GstRTSPHeaderField">
  1369. <doc xml:space="preserve">Enumeration of rtsp header fields</doc>
  1370. <member name="invalid"
  1371. value="0"
  1372. c:identifier="GST_RTSP_HDR_INVALID"
  1373. glib:nick="invalid">
  1374. </member>
  1375. <member name="accept"
  1376. value="1"
  1377. c:identifier="GST_RTSP_HDR_ACCEPT"
  1378. glib:nick="accept">
  1379. </member>
  1380. <member name="accept_encoding"
  1381. value="2"
  1382. c:identifier="GST_RTSP_HDR_ACCEPT_ENCODING"
  1383. glib:nick="accept-encoding">
  1384. </member>
  1385. <member name="accept_language"
  1386. value="3"
  1387. c:identifier="GST_RTSP_HDR_ACCEPT_LANGUAGE"
  1388. glib:nick="accept-language">
  1389. </member>
  1390. <member name="allow"
  1391. value="4"
  1392. c:identifier="GST_RTSP_HDR_ALLOW"
  1393. glib:nick="allow">
  1394. </member>
  1395. <member name="authorization"
  1396. value="5"
  1397. c:identifier="GST_RTSP_HDR_AUTHORIZATION"
  1398. glib:nick="authorization">
  1399. </member>
  1400. <member name="bandwidth"
  1401. value="6"
  1402. c:identifier="GST_RTSP_HDR_BANDWIDTH"
  1403. glib:nick="bandwidth">
  1404. </member>
  1405. <member name="blocksize"
  1406. value="7"
  1407. c:identifier="GST_RTSP_HDR_BLOCKSIZE"
  1408. glib:nick="blocksize">
  1409. </member>
  1410. <member name="cache_control"
  1411. value="8"
  1412. c:identifier="GST_RTSP_HDR_CACHE_CONTROL"
  1413. glib:nick="cache-control">
  1414. </member>
  1415. <member name="conference"
  1416. value="9"
  1417. c:identifier="GST_RTSP_HDR_CONFERENCE"
  1418. glib:nick="conference">
  1419. </member>
  1420. <member name="connection"
  1421. value="10"
  1422. c:identifier="GST_RTSP_HDR_CONNECTION"
  1423. glib:nick="connection">
  1424. </member>
  1425. <member name="content_base"
  1426. value="11"
  1427. c:identifier="GST_RTSP_HDR_CONTENT_BASE"
  1428. glib:nick="content-base">
  1429. </member>
  1430. <member name="content_encoding"
  1431. value="12"
  1432. c:identifier="GST_RTSP_HDR_CONTENT_ENCODING"
  1433. glib:nick="content-encoding">
  1434. </member>
  1435. <member name="content_language"
  1436. value="13"
  1437. c:identifier="GST_RTSP_HDR_CONTENT_LANGUAGE"
  1438. glib:nick="content-language">
  1439. </member>
  1440. <member name="content_length"
  1441. value="14"
  1442. c:identifier="GST_RTSP_HDR_CONTENT_LENGTH"
  1443. glib:nick="content-length">
  1444. </member>
  1445. <member name="content_location"
  1446. value="15"
  1447. c:identifier="GST_RTSP_HDR_CONTENT_LOCATION"
  1448. glib:nick="content-location">
  1449. </member>
  1450. <member name="content_type"
  1451. value="16"
  1452. c:identifier="GST_RTSP_HDR_CONTENT_TYPE"
  1453. glib:nick="content-type">
  1454. </member>
  1455. <member name="cseq"
  1456. value="17"
  1457. c:identifier="GST_RTSP_HDR_CSEQ"
  1458. glib:nick="cseq">
  1459. </member>
  1460. <member name="date"
  1461. value="18"
  1462. c:identifier="GST_RTSP_HDR_DATE"
  1463. glib:nick="date">
  1464. </member>
  1465. <member name="expires"
  1466. value="19"
  1467. c:identifier="GST_RTSP_HDR_EXPIRES"
  1468. glib:nick="expires">
  1469. </member>
  1470. <member name="from"
  1471. value="20"
  1472. c:identifier="GST_RTSP_HDR_FROM"
  1473. glib:nick="from">
  1474. </member>
  1475. <member name="if_modified_since"
  1476. value="21"
  1477. c:identifier="GST_RTSP_HDR_IF_MODIFIED_SINCE"
  1478. glib:nick="if-modified-since">
  1479. </member>
  1480. <member name="last_modified"
  1481. value="22"
  1482. c:identifier="GST_RTSP_HDR_LAST_MODIFIED"
  1483. glib:nick="last-modified">
  1484. </member>
  1485. <member name="proxy_authenticate"
  1486. value="23"
  1487. c:identifier="GST_RTSP_HDR_PROXY_AUTHENTICATE"
  1488. glib:nick="proxy-authenticate">
  1489. </member>
  1490. <member name="proxy_require"
  1491. value="24"
  1492. c:identifier="GST_RTSP_HDR_PROXY_REQUIRE"
  1493. glib:nick="proxy-require">
  1494. </member>
  1495. <member name="public"
  1496. value="25"
  1497. c:identifier="GST_RTSP_HDR_PUBLIC"
  1498. glib:nick="public">
  1499. </member>
  1500. <member name="range"
  1501. value="26"
  1502. c:identifier="GST_RTSP_HDR_RANGE"
  1503. glib:nick="range">
  1504. </member>
  1505. <member name="referer"
  1506. value="27"
  1507. c:identifier="GST_RTSP_HDR_REFERER"
  1508. glib:nick="referer">
  1509. </member>
  1510. <member name="require"
  1511. value="28"
  1512. c:identifier="GST_RTSP_HDR_REQUIRE"
  1513. glib:nick="require">
  1514. </member>
  1515. <member name="retry_after"
  1516. value="29"
  1517. c:identifier="GST_RTSP_HDR_RETRY_AFTER"
  1518. glib:nick="retry-after">
  1519. </member>
  1520. <member name="rtp_info"
  1521. value="30"
  1522. c:identifier="GST_RTSP_HDR_RTP_INFO"
  1523. glib:nick="rtp-info">
  1524. </member>
  1525. <member name="scale"
  1526. value="31"
  1527. c:identifier="GST_RTSP_HDR_SCALE"
  1528. glib:nick="scale">
  1529. </member>
  1530. <member name="session"
  1531. value="32"
  1532. c:identifier="GST_RTSP_HDR_SESSION"
  1533. glib:nick="session">
  1534. </member>
  1535. <member name="server"
  1536. value="33"
  1537. c:identifier="GST_RTSP_HDR_SERVER"
  1538. glib:nick="server">
  1539. </member>
  1540. <member name="speed"
  1541. value="34"
  1542. c:identifier="GST_RTSP_HDR_SPEED"
  1543. glib:nick="speed">
  1544. </member>
  1545. <member name="transport"
  1546. value="35"
  1547. c:identifier="GST_RTSP_HDR_TRANSPORT"
  1548. glib:nick="transport">
  1549. </member>
  1550. <member name="unsupported"
  1551. value="36"
  1552. c:identifier="GST_RTSP_HDR_UNSUPPORTED"
  1553. glib:nick="unsupported">
  1554. </member>
  1555. <member name="user_agent"
  1556. value="37"
  1557. c:identifier="GST_RTSP_HDR_USER_AGENT"
  1558. glib:nick="user-agent">
  1559. </member>
  1560. <member name="via"
  1561. value="38"
  1562. c:identifier="GST_RTSP_HDR_VIA"
  1563. glib:nick="via">
  1564. </member>
  1565. <member name="www_authenticate"
  1566. value="39"
  1567. c:identifier="GST_RTSP_HDR_WWW_AUTHENTICATE"
  1568. glib:nick="www-authenticate">
  1569. </member>
  1570. <member name="client_challenge"
  1571. value="40"
  1572. c:identifier="GST_RTSP_HDR_CLIENT_CHALLENGE"
  1573. glib:nick="client-challenge">
  1574. </member>
  1575. <member name="real_challenge1"
  1576. value="41"
  1577. c:identifier="GST_RTSP_HDR_REAL_CHALLENGE1"
  1578. glib:nick="real-challenge1">
  1579. </member>
  1580. <member name="real_challenge2"
  1581. value="42"
  1582. c:identifier="GST_RTSP_HDR_REAL_CHALLENGE2"
  1583. glib:nick="real-challenge2">
  1584. </member>
  1585. <member name="real_challenge3"
  1586. value="43"
  1587. c:identifier="GST_RTSP_HDR_REAL_CHALLENGE3"
  1588. glib:nick="real-challenge3">
  1589. </member>
  1590. <member name="subscribe"
  1591. value="44"
  1592. c:identifier="GST_RTSP_HDR_SUBSCRIBE"
  1593. glib:nick="subscribe">
  1594. </member>
  1595. <member name="alert"
  1596. value="45"
  1597. c:identifier="GST_RTSP_HDR_ALERT"
  1598. glib:nick="alert">
  1599. </member>
  1600. <member name="client_id"
  1601. value="46"
  1602. c:identifier="GST_RTSP_HDR_CLIENT_ID"
  1603. glib:nick="client-id">
  1604. </member>
  1605. <member name="company_id"
  1606. value="47"
  1607. c:identifier="GST_RTSP_HDR_COMPANY_ID"
  1608. glib:nick="company-id">
  1609. </member>
  1610. <member name="guid"
  1611. value="48"
  1612. c:identifier="GST_RTSP_HDR_GUID"
  1613. glib:nick="guid">
  1614. </member>
  1615. <member name="region_data"
  1616. value="49"
  1617. c:identifier="GST_RTSP_HDR_REGION_DATA"
  1618. glib:nick="region-data">
  1619. </member>
  1620. <member name="max_asm_width"
  1621. value="50"
  1622. c:identifier="GST_RTSP_HDR_MAX_ASM_WIDTH"
  1623. glib:nick="max-asm-width">
  1624. </member>
  1625. <member name="language"
  1626. value="51"
  1627. c:identifier="GST_RTSP_HDR_LANGUAGE"
  1628. glib:nick="language">
  1629. </member>
  1630. <member name="player_start_time"
  1631. value="52"
  1632. c:identifier="GST_RTSP_HDR_PLAYER_START_TIME"
  1633. glib:nick="player-start-time">
  1634. </member>
  1635. <member name="location"
  1636. value="53"
  1637. c:identifier="GST_RTSP_HDR_LOCATION"
  1638. glib:nick="location">
  1639. </member>
  1640. <member name="etag"
  1641. value="54"
  1642. c:identifier="GST_RTSP_HDR_ETAG"
  1643. glib:nick="etag">
  1644. </member>
  1645. <member name="if_match"
  1646. value="55"
  1647. c:identifier="GST_RTSP_HDR_IF_MATCH"
  1648. glib:nick="if-match">
  1649. </member>
  1650. <member name="accept_charset"
  1651. value="56"
  1652. c:identifier="GST_RTSP_HDR_ACCEPT_CHARSET"
  1653. glib:nick="accept-charset">
  1654. </member>
  1655. <member name="supported"
  1656. value="57"
  1657. c:identifier="GST_RTSP_HDR_SUPPORTED"
  1658. glib:nick="supported">
  1659. </member>
  1660. <member name="vary"
  1661. value="58"
  1662. c:identifier="GST_RTSP_HDR_VARY"
  1663. glib:nick="vary">
  1664. </member>
  1665. <member name="x_accelerate_streaming"
  1666. value="59"
  1667. c:identifier="GST_RTSP_HDR_X_ACCELERATE_STREAMING"
  1668. glib:nick="x-accelerate-streaming">
  1669. </member>
  1670. <member name="x_accept_authent"
  1671. value="60"
  1672. c:identifier="GST_RTSP_HDR_X_ACCEPT_AUTHENT"
  1673. glib:nick="x-accept-authent">
  1674. </member>
  1675. <member name="x_accept_proxy_authent"
  1676. value="61"
  1677. c:identifier="GST_RTSP_HDR_X_ACCEPT_PROXY_AUTHENT"
  1678. glib:nick="x-accept-proxy-authent">
  1679. </member>
  1680. <member name="x_broadcast_id"
  1681. value="62"
  1682. c:identifier="GST_RTSP_HDR_X_BROADCAST_ID"
  1683. glib:nick="x-broadcast-id">
  1684. </member>
  1685. <member name="x_burst_streaming"
  1686. value="63"
  1687. c:identifier="GST_RTSP_HDR_X_BURST_STREAMING"
  1688. glib:nick="x-burst-streaming">
  1689. </member>
  1690. <member name="x_notice"
  1691. value="64"
  1692. c:identifier="GST_RTSP_HDR_X_NOTICE"
  1693. glib:nick="x-notice">
  1694. </member>
  1695. <member name="x_player_lag_time"
  1696. value="65"
  1697. c:identifier="GST_RTSP_HDR_X_PLAYER_LAG_TIME"
  1698. glib:nick="x-player-lag-time">
  1699. </member>
  1700. <member name="x_playlist"
  1701. value="66"
  1702. c:identifier="GST_RTSP_HDR_X_PLAYLIST"
  1703. glib:nick="x-playlist">
  1704. </member>
  1705. <member name="x_playlist_change_notice"
  1706. value="67"
  1707. c:identifier="GST_RTSP_HDR_X_PLAYLIST_CHANGE_NOTICE"
  1708. glib:nick="x-playlist-change-notice">
  1709. </member>
  1710. <member name="x_playlist_gen_id"
  1711. value="68"
  1712. c:identifier="GST_RTSP_HDR_X_PLAYLIST_GEN_ID"
  1713. glib:nick="x-playlist-gen-id">
  1714. </member>
  1715. <member name="x_playlist_seek_id"
  1716. value="69"
  1717. c:identifier="GST_RTSP_HDR_X_PLAYLIST_SEEK_ID"
  1718. glib:nick="x-playlist-seek-id">
  1719. </member>
  1720. <member name="x_proxy_client_agent"
  1721. value="70"
  1722. c:identifier="GST_RTSP_HDR_X_PROXY_CLIENT_AGENT"
  1723. glib:nick="x-proxy-client-agent">
  1724. </member>
  1725. <member name="x_proxy_client_verb"
  1726. value="71"
  1727. c:identifier="GST_RTSP_HDR_X_PROXY_CLIENT_VERB"
  1728. glib:nick="x-proxy-client-verb">
  1729. </member>
  1730. <member name="x_receding_playlistchange"
  1731. value="72"
  1732. c:identifier="GST_RTSP_HDR_X_RECEDING_PLAYLISTCHANGE"
  1733. glib:nick="x-receding-playlistchange">
  1734. </member>
  1735. <member name="x_rtp_info"
  1736. value="73"
  1737. c:identifier="GST_RTSP_HDR_X_RTP_INFO"
  1738. glib:nick="x-rtp-info">
  1739. </member>
  1740. <member name="x_startupprofile"
  1741. value="74"
  1742. c:identifier="GST_RTSP_HDR_X_STARTUPPROFILE"
  1743. glib:nick="x-startupprofile">
  1744. </member>
  1745. <member name="timestamp"
  1746. value="75"
  1747. c:identifier="GST_RTSP_HDR_TIMESTAMP"
  1748. glib:nick="timestamp">
  1749. </member>
  1750. <member name="authentication_info"
  1751. value="76"
  1752. c:identifier="GST_RTSP_HDR_AUTHENTICATION_INFO"
  1753. glib:nick="authentication-info">
  1754. </member>
  1755. <member name="host"
  1756. value="77"
  1757. c:identifier="GST_RTSP_HDR_HOST"
  1758. glib:nick="host">
  1759. </member>
  1760. <member name="pragma"
  1761. value="78"
  1762. c:identifier="GST_RTSP_HDR_PRAGMA"
  1763. glib:nick="pragma">
  1764. </member>
  1765. <member name="x_server_ip_address"
  1766. value="79"
  1767. c:identifier="GST_RTSP_HDR_X_SERVER_IP_ADDRESS"
  1768. glib:nick="x-server-ip-address">
  1769. </member>
  1770. <member name="x_sessioncookie"
  1771. value="80"
  1772. c:identifier="GST_RTSP_HDR_X_SESSIONCOOKIE"
  1773. glib:nick="x-sessioncookie">
  1774. </member>
  1775. <member name="rtcp_interval"
  1776. value="81"
  1777. c:identifier="GST_RTSP_HDR_RTCP_INTERVAL"
  1778. glib:nick="rtcp-interval">
  1779. </member>
  1780. <member name="keymgmt"
  1781. value="82"
  1782. c:identifier="GST_RTSP_HDR_KEYMGMT"
  1783. glib:nick="keymgmt">
  1784. </member>
  1785. <member name="last"
  1786. value="83"
  1787. c:identifier="GST_RTSP_HDR_LAST"
  1788. glib:nick="last">
  1789. </member>
  1790. </enumeration>
  1791. <bitfield name="RTSPLowerTrans"
  1792. glib:type-name="GstRTSPLowerTrans"
  1793. glib:get-type="gst_rtsp_lower_trans_get_type"
  1794. c:type="GstRTSPLowerTrans">
  1795. <doc xml:space="preserve">The different transport methods.</doc>
  1796. <member name="unknown"
  1797. value="0"
  1798. c:identifier="GST_RTSP_LOWER_TRANS_UNKNOWN"
  1799. glib:nick="unknown">
  1800. <doc xml:space="preserve">invalid transport flag</doc>
  1801. </member>
  1802. <member name="udp"
  1803. value="1"
  1804. c:identifier="GST_RTSP_LOWER_TRANS_UDP"
  1805. glib:nick="udp">
  1806. <doc xml:space="preserve">stream data over UDP</doc>
  1807. </member>
  1808. <member name="udp_mcast"
  1809. value="2"
  1810. c:identifier="GST_RTSP_LOWER_TRANS_UDP_MCAST"
  1811. glib:nick="udp-mcast">
  1812. <doc xml:space="preserve">stream data over UDP multicast</doc>
  1813. </member>
  1814. <member name="tcp"
  1815. value="4"
  1816. c:identifier="GST_RTSP_LOWER_TRANS_TCP"
  1817. glib:nick="tcp">
  1818. <doc xml:space="preserve">stream data over TCP</doc>
  1819. </member>
  1820. <member name="http"
  1821. value="16"
  1822. c:identifier="GST_RTSP_LOWER_TRANS_HTTP"
  1823. glib:nick="http">
  1824. <doc xml:space="preserve">stream data tunneled over HTTP.</doc>
  1825. </member>
  1826. <member name="tls"
  1827. value="32"
  1828. c:identifier="GST_RTSP_LOWER_TRANS_TLS"
  1829. glib:nick="tls">
  1830. <doc xml:space="preserve">encrypt TCP and HTTP with TLS</doc>
  1831. </member>
  1832. </bitfield>
  1833. <record name="RTSPMessage" c:type="GstRTSPMessage">
  1834. <doc xml:space="preserve">Provides methods for creating and parsing request, response and data messages.</doc>
  1835. <field name="type" writable="1">
  1836. <doc xml:space="preserve">the message type</doc>
  1837. <type name="RTSPMsgType" c:type="GstRTSPMsgType"/>
  1838. </field>
  1839. <union name="type_data" c:type="type_data">
  1840. <record name="request" c:type="request">
  1841. <field name="method" writable="1">
  1842. <type name="RTSPMethod" c:type="GstRTSPMethod"/>
  1843. </field>
  1844. <field name="uri" writable="1">
  1845. <type name="utf8" c:type="gchar*"/>
  1846. </field>
  1847. <field name="version" writable="1">
  1848. <type name="RTSPVersion" c:type="GstRTSPVersion"/>
  1849. </field>
  1850. </record>
  1851. <record name="response" c:type="response">
  1852. <field name="code" writable="1">
  1853. <type name="RTSPStatusCode" c:type="GstRTSPStatusCode"/>
  1854. </field>
  1855. <field name="reason" writable="1">
  1856. <type name="utf8" c:type="gchar*"/>
  1857. </field>
  1858. <field name="version" writable="1">
  1859. <type name="RTSPVersion" c:type="GstRTSPVersion"/>
  1860. </field>
  1861. </record>
  1862. <record name="data" c:type="data">
  1863. <field name="channel" writable="1">
  1864. <type name="guint8" c:type="guint8"/>
  1865. </field>
  1866. </record>
  1867. </union>
  1868. <field name="hdr_fields" readable="0" private="1">
  1869. <array name="GLib.Array" c:type="GArray*">
  1870. <type name="gpointer" c:type="gpointer"/>
  1871. </array>
  1872. </field>
  1873. <field name="body" readable="0" private="1">
  1874. <type name="guint8" c:type="guint8*"/>
  1875. </field>
  1876. <field name="body_size" readable="0" private="1">
  1877. <type name="guint" c:type="guint"/>
  1878. </field>
  1879. <field name="_gst_reserved" readable="0" private="1">
  1880. <array zero-terminated="0" c:type="gpointer" fixed-size="4">
  1881. <type name="gpointer" c:type="gpointer"/>
  1882. </array>
  1883. </field>
  1884. <method name="add_header" c:identifier="gst_rtsp_message_add_header">
  1885. <doc xml:space="preserve">Add a header with key @field and @value to @msg. This function takes a copy
  1886. of @value.</doc>
  1887. <return-value transfer-ownership="none">
  1888. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  1889. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1890. </return-value>
  1891. <parameters>
  1892. <instance-parameter name="msg" transfer-ownership="none">
  1893. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  1894. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1895. </instance-parameter>
  1896. <parameter name="field" transfer-ownership="none">
  1897. <doc xml:space="preserve">a #GstRTSPHeaderField</doc>
  1898. <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
  1899. </parameter>
  1900. <parameter name="value" transfer-ownership="none">
  1901. <doc xml:space="preserve">the value of the header</doc>
  1902. <type name="utf8" c:type="const gchar*"/>
  1903. </parameter>
  1904. </parameters>
  1905. </method>
  1906. <method name="add_header_by_name"
  1907. c:identifier="gst_rtsp_message_add_header_by_name"
  1908. version="1.6">
  1909. <doc xml:space="preserve">Add a header with key @header and @value to @msg. This function takes a copy
  1910. of @value.</doc>
  1911. <return-value transfer-ownership="none">
  1912. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  1913. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1914. </return-value>
  1915. <parameters>
  1916. <instance-parameter name="msg" transfer-ownership="none">
  1917. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  1918. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1919. </instance-parameter>
  1920. <parameter name="header" transfer-ownership="none">
  1921. <doc xml:space="preserve">header string</doc>
  1922. <type name="utf8" c:type="const gchar*"/>
  1923. </parameter>
  1924. <parameter name="value" transfer-ownership="none">
  1925. <doc xml:space="preserve">the value of the header</doc>
  1926. <type name="utf8" c:type="const gchar*"/>
  1927. </parameter>
  1928. </parameters>
  1929. </method>
  1930. <method name="append_headers"
  1931. c:identifier="gst_rtsp_message_append_headers">
  1932. <doc xml:space="preserve">Append the currently configured headers in @msg to the #GString @str suitable
  1933. for transmission.</doc>
  1934. <return-value transfer-ownership="none">
  1935. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  1936. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1937. </return-value>
  1938. <parameters>
  1939. <instance-parameter name="msg" transfer-ownership="none">
  1940. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  1941. <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
  1942. </instance-parameter>
  1943. <parameter name="str" transfer-ownership="none">
  1944. <doc xml:space="preserve">a string</doc>
  1945. <type name="GLib.String" c:type="GString*"/>
  1946. </parameter>
  1947. </parameters>
  1948. </method>
  1949. <method name="dump" c:identifier="gst_rtsp_message_dump">
  1950. <doc xml:space="preserve">Dump the contents of @msg to stdout.</doc>
  1951. <return-value transfer-ownership="none">
  1952. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  1953. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1954. </return-value>
  1955. <parameters>
  1956. <instance-parameter name="msg" transfer-ownership="none">
  1957. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  1958. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1959. </instance-parameter>
  1960. </parameters>
  1961. </method>
  1962. <method name="free" c:identifier="gst_rtsp_message_free">
  1963. <doc xml:space="preserve">Free the memory used by @msg.</doc>
  1964. <return-value transfer-ownership="none">
  1965. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  1966. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1967. </return-value>
  1968. <parameters>
  1969. <instance-parameter name="msg" transfer-ownership="none">
  1970. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  1971. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  1972. </instance-parameter>
  1973. </parameters>
  1974. </method>
  1975. <method name="get_body" c:identifier="gst_rtsp_message_get_body">
  1976. <doc xml:space="preserve">Get the body of @msg. @data remains valid for as long as @msg is valid and
  1977. unchanged.</doc>
  1978. <return-value transfer-ownership="none">
  1979. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  1980. <type name="RTSPResult" c:type="GstRTSPResult"/>
  1981. </return-value>
  1982. <parameters>
  1983. <instance-parameter name="msg" transfer-ownership="none">
  1984. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  1985. <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
  1986. </instance-parameter>
  1987. <parameter name="data"
  1988. direction="out"
  1989. caller-allocates="0"
  1990. transfer-ownership="none">
  1991. <doc xml:space="preserve">location for the data</doc>
  1992. <array length="1" zero-terminated="0" c:type="guint8**">
  1993. <type name="guint8" c:type="guint8*"/>
  1994. </array>
  1995. </parameter>
  1996. <parameter name="size"
  1997. direction="out"
  1998. caller-allocates="0"
  1999. transfer-ownership="full">
  2000. <doc xml:space="preserve">location for the size of @data</doc>
  2001. <type name="guint" c:type="guint*"/>
  2002. </parameter>
  2003. </parameters>
  2004. </method>
  2005. <method name="get_header" c:identifier="gst_rtsp_message_get_header">
  2006. <doc xml:space="preserve">Get the @indx header value with key @field from @msg. The result in @value
  2007. stays valid as long as it remains present in @msg.</doc>
  2008. <return-value transfer-ownership="none">
  2009. <doc xml:space="preserve">#GST_RTSP_OK when @field was found, #GST_RTSP_ENOTIMPL if the key
  2010. was not found.</doc>
  2011. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2012. </return-value>
  2013. <parameters>
  2014. <instance-parameter name="msg" transfer-ownership="none">
  2015. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2016. <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
  2017. </instance-parameter>
  2018. <parameter name="field" transfer-ownership="none">
  2019. <doc xml:space="preserve">a #GstRTSPHeaderField</doc>
  2020. <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
  2021. </parameter>
  2022. <parameter name="value"
  2023. direction="out"
  2024. caller-allocates="0"
  2025. transfer-ownership="none">
  2026. <doc xml:space="preserve">pointer to hold the result</doc>
  2027. <type name="utf8" c:type="gchar**"/>
  2028. </parameter>
  2029. <parameter name="indx" transfer-ownership="none">
  2030. <doc xml:space="preserve">the index of the header</doc>
  2031. <type name="gint" c:type="gint"/>
  2032. </parameter>
  2033. </parameters>
  2034. </method>
  2035. <method name="get_header_by_name"
  2036. c:identifier="gst_rtsp_message_get_header_by_name"
  2037. version="1.6">
  2038. <doc xml:space="preserve">Get the @index header value with key @header from @msg. The result in @value
  2039. stays valid as long as it remains present in @msg.</doc>
  2040. <return-value transfer-ownership="none">
  2041. <doc xml:space="preserve">#GST_RTSP_OK when @field was found, #GST_RTSP_ENOTIMPL if the key
  2042. was not found.</doc>
  2043. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2044. </return-value>
  2045. <parameters>
  2046. <instance-parameter name="msg" transfer-ownership="none">
  2047. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2048. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2049. </instance-parameter>
  2050. <parameter name="header" transfer-ownership="none">
  2051. <doc xml:space="preserve">a #GstRTSPHeaderField</doc>
  2052. <type name="utf8" c:type="const gchar*"/>
  2053. </parameter>
  2054. <parameter name="value"
  2055. direction="out"
  2056. caller-allocates="0"
  2057. transfer-ownership="none">
  2058. <doc xml:space="preserve">pointer to hold the result</doc>
  2059. <type name="utf8" c:type="gchar**"/>
  2060. </parameter>
  2061. <parameter name="index" transfer-ownership="none">
  2062. <doc xml:space="preserve">the index of the header</doc>
  2063. <type name="gint" c:type="gint"/>
  2064. </parameter>
  2065. </parameters>
  2066. </method>
  2067. <method name="get_type" c:identifier="gst_rtsp_message_get_type">
  2068. <doc xml:space="preserve">Get the message type of @msg.</doc>
  2069. <return-value transfer-ownership="none">
  2070. <doc xml:space="preserve">the message type.</doc>
  2071. <type name="RTSPMsgType" c:type="GstRTSPMsgType"/>
  2072. </return-value>
  2073. <parameters>
  2074. <instance-parameter name="msg" transfer-ownership="none">
  2075. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2076. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2077. </instance-parameter>
  2078. </parameters>
  2079. </method>
  2080. <method name="init" c:identifier="gst_rtsp_message_init">
  2081. <doc xml:space="preserve">Initialize @msg. This function is mostly used when @msg is allocated on the
  2082. stack. The reverse operation of this is gst_rtsp_message_unset().</doc>
  2083. <return-value transfer-ownership="none">
  2084. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2085. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2086. </return-value>
  2087. <parameters>
  2088. <instance-parameter name="msg" transfer-ownership="none">
  2089. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2090. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2091. </instance-parameter>
  2092. </parameters>
  2093. </method>
  2094. <method name="init_data" c:identifier="gst_rtsp_message_init_data">
  2095. <doc xml:space="preserve">Initialize a new data #GstRTSPMessage for @channel.</doc>
  2096. <return-value transfer-ownership="none">
  2097. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2098. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2099. </return-value>
  2100. <parameters>
  2101. <instance-parameter name="msg" transfer-ownership="none">
  2102. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2103. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2104. </instance-parameter>
  2105. <parameter name="channel" transfer-ownership="none">
  2106. <doc xml:space="preserve">a channel</doc>
  2107. <type name="guint8" c:type="guint8"/>
  2108. </parameter>
  2109. </parameters>
  2110. </method>
  2111. <method name="init_request" c:identifier="gst_rtsp_message_init_request">
  2112. <doc xml:space="preserve">Initialize @msg as a request message with @method and @uri. To clear @msg
  2113. again, use gst_rtsp_message_unset().</doc>
  2114. <return-value transfer-ownership="none">
  2115. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2116. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2117. </return-value>
  2118. <parameters>
  2119. <instance-parameter name="msg" transfer-ownership="none">
  2120. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2121. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2122. </instance-parameter>
  2123. <parameter name="method" transfer-ownership="none">
  2124. <doc xml:space="preserve">the request method to use</doc>
  2125. <type name="RTSPMethod" c:type="GstRTSPMethod"/>
  2126. </parameter>
  2127. <parameter name="uri" transfer-ownership="none">
  2128. <doc xml:space="preserve">the uri of the request</doc>
  2129. <type name="utf8" c:type="const gchar*"/>
  2130. </parameter>
  2131. </parameters>
  2132. </method>
  2133. <method name="init_response"
  2134. c:identifier="gst_rtsp_message_init_response">
  2135. <doc xml:space="preserve">Initialize @msg with @code and @reason.
  2136. When @reason is #NULL, the default reason for @code will be used.
  2137. When @request is not #NULL, the relevant headers will be copied to the new
  2138. response message.</doc>
  2139. <return-value transfer-ownership="none">
  2140. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2141. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2142. </return-value>
  2143. <parameters>
  2144. <instance-parameter name="msg" transfer-ownership="none">
  2145. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2146. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2147. </instance-parameter>
  2148. <parameter name="code" transfer-ownership="none">
  2149. <doc xml:space="preserve">the status code</doc>
  2150. <type name="RTSPStatusCode" c:type="GstRTSPStatusCode"/>
  2151. </parameter>
  2152. <parameter name="reason"
  2153. transfer-ownership="none"
  2154. nullable="1"
  2155. allow-none="1">
  2156. <doc xml:space="preserve">the status reason or %NULL</doc>
  2157. <type name="utf8" c:type="const gchar*"/>
  2158. </parameter>
  2159. <parameter name="request"
  2160. transfer-ownership="none"
  2161. nullable="1"
  2162. allow-none="1">
  2163. <doc xml:space="preserve">the request that triggered the response or %NULL</doc>
  2164. <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
  2165. </parameter>
  2166. </parameters>
  2167. </method>
  2168. <method name="parse_data" c:identifier="gst_rtsp_message_parse_data">
  2169. <doc xml:space="preserve">Parse the data message @msg and store the channel in @channel.</doc>
  2170. <return-value transfer-ownership="none">
  2171. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2172. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2173. </return-value>
  2174. <parameters>
  2175. <instance-parameter name="msg" transfer-ownership="none">
  2176. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2177. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2178. </instance-parameter>
  2179. <parameter name="channel"
  2180. direction="out"
  2181. caller-allocates="0"
  2182. transfer-ownership="full">
  2183. <doc xml:space="preserve">location to hold the channel</doc>
  2184. <type name="guint8" c:type="guint8*"/>
  2185. </parameter>
  2186. </parameters>
  2187. </method>
  2188. <method name="parse_request"
  2189. c:identifier="gst_rtsp_message_parse_request">
  2190. <doc xml:space="preserve">Parse the request message @msg and store the values @method, @uri and
  2191. @version. The result locations can be #NULL if one is not interested in its
  2192. value.
  2193. @uri remains valid for as long as @msg is valid and unchanged.</doc>
  2194. <return-value transfer-ownership="none">
  2195. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2196. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2197. </return-value>
  2198. <parameters>
  2199. <instance-parameter name="msg" transfer-ownership="none">
  2200. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2201. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2202. </instance-parameter>
  2203. <parameter name="method"
  2204. direction="out"
  2205. caller-allocates="0"
  2206. transfer-ownership="full"
  2207. optional="1"
  2208. allow-none="1">
  2209. <doc xml:space="preserve">location to hold the method</doc>
  2210. <type name="RTSPMethod" c:type="GstRTSPMethod*"/>
  2211. </parameter>
  2212. <parameter name="uri"
  2213. direction="out"
  2214. caller-allocates="0"
  2215. transfer-ownership="full"
  2216. optional="1"
  2217. allow-none="1">
  2218. <doc xml:space="preserve">location to hold the uri</doc>
  2219. <type name="utf8" c:type="const gchar**"/>
  2220. </parameter>
  2221. <parameter name="version"
  2222. direction="out"
  2223. caller-allocates="0"
  2224. transfer-ownership="full"
  2225. optional="1"
  2226. allow-none="1">
  2227. <doc xml:space="preserve">location to hold the version</doc>
  2228. <type name="RTSPVersion" c:type="GstRTSPVersion*"/>
  2229. </parameter>
  2230. </parameters>
  2231. </method>
  2232. <method name="parse_response"
  2233. c:identifier="gst_rtsp_message_parse_response">
  2234. <doc xml:space="preserve">Parse the response message @msg and store the values @code, @reason and
  2235. @version. The result locations can be #NULL if one is not interested in its
  2236. value.
  2237. @reason remains valid for as long as @msg is valid and unchanged.</doc>
  2238. <return-value transfer-ownership="none">
  2239. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2240. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2241. </return-value>
  2242. <parameters>
  2243. <instance-parameter name="msg" transfer-ownership="none">
  2244. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2245. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2246. </instance-parameter>
  2247. <parameter name="code"
  2248. direction="out"
  2249. caller-allocates="0"
  2250. transfer-ownership="full"
  2251. optional="1"
  2252. allow-none="1">
  2253. <doc xml:space="preserve">location to hold the status code</doc>
  2254. <type name="RTSPStatusCode" c:type="GstRTSPStatusCode*"/>
  2255. </parameter>
  2256. <parameter name="reason"
  2257. direction="out"
  2258. caller-allocates="0"
  2259. transfer-ownership="full"
  2260. optional="1"
  2261. allow-none="1">
  2262. <doc xml:space="preserve">location to hold the status reason</doc>
  2263. <type name="utf8" c:type="const gchar**"/>
  2264. </parameter>
  2265. <parameter name="version"
  2266. direction="out"
  2267. caller-allocates="0"
  2268. transfer-ownership="full"
  2269. optional="1"
  2270. allow-none="1">
  2271. <doc xml:space="preserve">location to hold the version</doc>
  2272. <type name="RTSPVersion" c:type="GstRTSPVersion*"/>
  2273. </parameter>
  2274. </parameters>
  2275. </method>
  2276. <method name="remove_header"
  2277. c:identifier="gst_rtsp_message_remove_header">
  2278. <doc xml:space="preserve">Remove the @indx header with key @field from @msg. If @indx equals -1, all
  2279. headers will be removed.</doc>
  2280. <return-value transfer-ownership="none">
  2281. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2282. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2283. </return-value>
  2284. <parameters>
  2285. <instance-parameter name="msg" transfer-ownership="none">
  2286. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2287. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2288. </instance-parameter>
  2289. <parameter name="field" transfer-ownership="none">
  2290. <doc xml:space="preserve">a #GstRTSPHeaderField</doc>
  2291. <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
  2292. </parameter>
  2293. <parameter name="indx" transfer-ownership="none">
  2294. <doc xml:space="preserve">the index of the header</doc>
  2295. <type name="gint" c:type="gint"/>
  2296. </parameter>
  2297. </parameters>
  2298. </method>
  2299. <method name="remove_header_by_name"
  2300. c:identifier="gst_rtsp_message_remove_header_by_name"
  2301. version="1.6">
  2302. <doc xml:space="preserve">Remove the @index header with key @header from @msg. If @index equals -1,
  2303. all matching headers will be removed.</doc>
  2304. <return-value transfer-ownership="none">
  2305. <doc xml:space="preserve">a #GstRTSPResult</doc>
  2306. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2307. </return-value>
  2308. <parameters>
  2309. <instance-parameter name="msg" transfer-ownership="none">
  2310. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2311. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2312. </instance-parameter>
  2313. <parameter name="header" transfer-ownership="none">
  2314. <doc xml:space="preserve">the header string</doc>
  2315. <type name="utf8" c:type="const gchar*"/>
  2316. </parameter>
  2317. <parameter name="index" transfer-ownership="none">
  2318. <doc xml:space="preserve">the index of the header</doc>
  2319. <type name="gint" c:type="gint"/>
  2320. </parameter>
  2321. </parameters>
  2322. </method>
  2323. <method name="set_body" c:identifier="gst_rtsp_message_set_body">
  2324. <doc xml:space="preserve">Set the body of @msg to a copy of @data.</doc>
  2325. <return-value transfer-ownership="none">
  2326. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  2327. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2328. </return-value>
  2329. <parameters>
  2330. <instance-parameter name="msg" transfer-ownership="none">
  2331. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2332. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2333. </instance-parameter>
  2334. <parameter name="data" transfer-ownership="none">
  2335. <doc xml:space="preserve">the data</doc>
  2336. <array length="1" zero-terminated="0" c:type="guint8*">
  2337. <type name="guint8" c:type="guint8"/>
  2338. </array>
  2339. </parameter>
  2340. <parameter name="size" transfer-ownership="none">
  2341. <doc xml:space="preserve">the size of @data</doc>
  2342. <type name="guint" c:type="guint"/>
  2343. </parameter>
  2344. </parameters>
  2345. </method>
  2346. <method name="steal_body" c:identifier="gst_rtsp_message_steal_body">
  2347. <doc xml:space="preserve">Take the body of @msg and store it in @data and @size. After this method,
  2348. the body and size of @msg will be set to #NULL and 0 respectively.</doc>
  2349. <return-value transfer-ownership="none">
  2350. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  2351. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2352. </return-value>
  2353. <parameters>
  2354. <instance-parameter name="msg" transfer-ownership="none">
  2355. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2356. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2357. </instance-parameter>
  2358. <parameter name="data"
  2359. direction="out"
  2360. caller-allocates="0"
  2361. transfer-ownership="full">
  2362. <doc xml:space="preserve">location for the data</doc>
  2363. <array length="1" zero-terminated="0" c:type="guint8**">
  2364. <type name="guint8" c:type="guint8*"/>
  2365. </array>
  2366. </parameter>
  2367. <parameter name="size"
  2368. direction="out"
  2369. caller-allocates="0"
  2370. transfer-ownership="full">
  2371. <doc xml:space="preserve">location for the size of @data</doc>
  2372. <type name="guint" c:type="guint*"/>
  2373. </parameter>
  2374. </parameters>
  2375. </method>
  2376. <method name="take_body" c:identifier="gst_rtsp_message_take_body">
  2377. <doc xml:space="preserve">Set the body of @msg to @data and @size. This method takes ownership of
  2378. @data.</doc>
  2379. <return-value transfer-ownership="none">
  2380. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  2381. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2382. </return-value>
  2383. <parameters>
  2384. <instance-parameter name="msg" transfer-ownership="none">
  2385. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2386. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2387. </instance-parameter>
  2388. <parameter name="data" transfer-ownership="full">
  2389. <doc xml:space="preserve">the data</doc>
  2390. <array length="1" zero-terminated="0" c:type="guint8*">
  2391. <type name="guint8" c:type="guint8"/>
  2392. </array>
  2393. </parameter>
  2394. <parameter name="size" transfer-ownership="none">
  2395. <doc xml:space="preserve">the size of @data</doc>
  2396. <type name="guint" c:type="guint"/>
  2397. </parameter>
  2398. </parameters>
  2399. </method>
  2400. <method name="take_header" c:identifier="gst_rtsp_message_take_header">
  2401. <doc xml:space="preserve">Add a header with key @field and @value to @msg. This function takes
  2402. ownership of @value.</doc>
  2403. <return-value transfer-ownership="none">
  2404. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2405. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2406. </return-value>
  2407. <parameters>
  2408. <instance-parameter name="msg" transfer-ownership="none">
  2409. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2410. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2411. </instance-parameter>
  2412. <parameter name="field" transfer-ownership="none">
  2413. <doc xml:space="preserve">a #GstRTSPHeaderField</doc>
  2414. <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
  2415. </parameter>
  2416. <parameter name="value" transfer-ownership="full">
  2417. <doc xml:space="preserve">the value of the header</doc>
  2418. <type name="utf8" c:type="gchar*"/>
  2419. </parameter>
  2420. </parameters>
  2421. </method>
  2422. <method name="take_header_by_name"
  2423. c:identifier="gst_rtsp_message_take_header_by_name"
  2424. version="1.6">
  2425. <doc xml:space="preserve">Add a header with key @header and @value to @msg. This function takes
  2426. ownership of @value, but not of @header.</doc>
  2427. <return-value transfer-ownership="none">
  2428. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2429. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2430. </return-value>
  2431. <parameters>
  2432. <instance-parameter name="msg" transfer-ownership="none">
  2433. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2434. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2435. </instance-parameter>
  2436. <parameter name="header" transfer-ownership="none">
  2437. <doc xml:space="preserve">a header string</doc>
  2438. <type name="utf8" c:type="const gchar*"/>
  2439. </parameter>
  2440. <parameter name="value" transfer-ownership="full">
  2441. <doc xml:space="preserve">the value of the header</doc>
  2442. <type name="utf8" c:type="gchar*"/>
  2443. </parameter>
  2444. </parameters>
  2445. </method>
  2446. <method name="unset" c:identifier="gst_rtsp_message_unset">
  2447. <doc xml:space="preserve">Unset the contents of @msg so that it becomes an uninitialized
  2448. #GstRTSPMessage again. This function is mostly used in combination with
  2449. gst_rtsp_message_init_request(), gst_rtsp_message_init_response() and
  2450. gst_rtsp_message_init_data() on stack allocated #GstRTSPMessage structures.</doc>
  2451. <return-value transfer-ownership="none">
  2452. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  2453. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2454. </return-value>
  2455. <parameters>
  2456. <instance-parameter name="msg" transfer-ownership="none">
  2457. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  2458. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  2459. </instance-parameter>
  2460. </parameters>
  2461. </method>
  2462. <function name="new" c:identifier="gst_rtsp_message_new">
  2463. <doc xml:space="preserve">Create a new initialized #GstRTSPMessage. Free with gst_rtsp_message_free().</doc>
  2464. <return-value transfer-ownership="none">
  2465. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2466. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2467. </return-value>
  2468. <parameters>
  2469. <parameter name="msg"
  2470. direction="out"
  2471. caller-allocates="0"
  2472. transfer-ownership="full">
  2473. <doc xml:space="preserve">a location for the new #GstRTSPMessage</doc>
  2474. <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
  2475. </parameter>
  2476. </parameters>
  2477. </function>
  2478. <function name="new_data" c:identifier="gst_rtsp_message_new_data">
  2479. <doc xml:space="preserve">Create a new data #GstRTSPMessage with @channel and store the
  2480. result message in @msg. Free with gst_rtsp_message_free().</doc>
  2481. <return-value transfer-ownership="none">
  2482. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2483. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2484. </return-value>
  2485. <parameters>
  2486. <parameter name="msg"
  2487. direction="out"
  2488. caller-allocates="0"
  2489. transfer-ownership="full">
  2490. <doc xml:space="preserve">a location for the new #GstRTSPMessage</doc>
  2491. <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
  2492. </parameter>
  2493. <parameter name="channel" transfer-ownership="none">
  2494. <doc xml:space="preserve">the channel</doc>
  2495. <type name="guint8" c:type="guint8"/>
  2496. </parameter>
  2497. </parameters>
  2498. </function>
  2499. <function name="new_request" c:identifier="gst_rtsp_message_new_request">
  2500. <doc xml:space="preserve">Create a new #GstRTSPMessage with @method and @uri and store the result
  2501. request message in @msg. Free with gst_rtsp_message_free().</doc>
  2502. <return-value transfer-ownership="none">
  2503. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2504. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2505. </return-value>
  2506. <parameters>
  2507. <parameter name="msg"
  2508. direction="out"
  2509. caller-allocates="0"
  2510. transfer-ownership="full">
  2511. <doc xml:space="preserve">a location for the new #GstRTSPMessage</doc>
  2512. <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
  2513. </parameter>
  2514. <parameter name="method" transfer-ownership="none">
  2515. <doc xml:space="preserve">the request method to use</doc>
  2516. <type name="RTSPMethod" c:type="GstRTSPMethod"/>
  2517. </parameter>
  2518. <parameter name="uri" transfer-ownership="none">
  2519. <doc xml:space="preserve">the uri of the request</doc>
  2520. <type name="utf8" c:type="const gchar*"/>
  2521. </parameter>
  2522. </parameters>
  2523. </function>
  2524. <function name="new_response"
  2525. c:identifier="gst_rtsp_message_new_response">
  2526. <doc xml:space="preserve">Create a new response #GstRTSPMessage with @code and @reason and store the
  2527. result message in @msg. Free with gst_rtsp_message_free().
  2528. When @reason is #NULL, the default reason for @code will be used.
  2529. When @request is not #NULL, the relevant headers will be copied to the new
  2530. response message.</doc>
  2531. <return-value transfer-ownership="none">
  2532. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  2533. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2534. </return-value>
  2535. <parameters>
  2536. <parameter name="msg"
  2537. direction="out"
  2538. caller-allocates="0"
  2539. transfer-ownership="full">
  2540. <doc xml:space="preserve">a location for the new #GstRTSPMessage</doc>
  2541. <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
  2542. </parameter>
  2543. <parameter name="code" transfer-ownership="none">
  2544. <doc xml:space="preserve">the status code</doc>
  2545. <type name="RTSPStatusCode" c:type="GstRTSPStatusCode"/>
  2546. </parameter>
  2547. <parameter name="reason"
  2548. transfer-ownership="none"
  2549. nullable="1"
  2550. allow-none="1">
  2551. <doc xml:space="preserve">the status reason or %NULL</doc>
  2552. <type name="utf8" c:type="const gchar*"/>
  2553. </parameter>
  2554. <parameter name="request"
  2555. transfer-ownership="none"
  2556. nullable="1"
  2557. allow-none="1">
  2558. <doc xml:space="preserve">the request that triggered the response or %NULL</doc>
  2559. <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
  2560. </parameter>
  2561. </parameters>
  2562. </function>
  2563. </record>
  2564. <bitfield name="RTSPMethod"
  2565. glib:type-name="GstRTSPMethod"
  2566. glib:get-type="gst_rtsp_method_get_type"
  2567. c:type="GstRTSPMethod">
  2568. <doc xml:space="preserve">The different supported RTSP methods.</doc>
  2569. <member name="invalid"
  2570. value="0"
  2571. c:identifier="GST_RTSP_INVALID"
  2572. glib:nick="invalid">
  2573. <doc xml:space="preserve">invalid method</doc>
  2574. </member>
  2575. <member name="describe"
  2576. value="1"
  2577. c:identifier="GST_RTSP_DESCRIBE"
  2578. glib:nick="describe">
  2579. <doc xml:space="preserve">the DESCRIBE method</doc>
  2580. </member>
  2581. <member name="announce"
  2582. value="2"
  2583. c:identifier="GST_RTSP_ANNOUNCE"
  2584. glib:nick="announce">
  2585. <doc xml:space="preserve">the ANNOUNCE method</doc>
  2586. </member>
  2587. <member name="get_parameter"
  2588. value="4"
  2589. c:identifier="GST_RTSP_GET_PARAMETER"
  2590. glib:nick="get-parameter">
  2591. <doc xml:space="preserve">the GET_PARAMETER method</doc>
  2592. </member>
  2593. <member name="options"
  2594. value="8"
  2595. c:identifier="GST_RTSP_OPTIONS"
  2596. glib:nick="options">
  2597. <doc xml:space="preserve">the OPTIONS method</doc>
  2598. </member>
  2599. <member name="pause"
  2600. value="16"
  2601. c:identifier="GST_RTSP_PAUSE"
  2602. glib:nick="pause">
  2603. <doc xml:space="preserve">the PAUSE method</doc>
  2604. </member>
  2605. <member name="play"
  2606. value="32"
  2607. c:identifier="GST_RTSP_PLAY"
  2608. glib:nick="play">
  2609. <doc xml:space="preserve">the PLAY method</doc>
  2610. </member>
  2611. <member name="record"
  2612. value="64"
  2613. c:identifier="GST_RTSP_RECORD"
  2614. glib:nick="record">
  2615. <doc xml:space="preserve">the RECORD method</doc>
  2616. </member>
  2617. <member name="redirect"
  2618. value="128"
  2619. c:identifier="GST_RTSP_REDIRECT"
  2620. glib:nick="redirect">
  2621. <doc xml:space="preserve">the REDIRECT method</doc>
  2622. </member>
  2623. <member name="setup"
  2624. value="256"
  2625. c:identifier="GST_RTSP_SETUP"
  2626. glib:nick="setup">
  2627. <doc xml:space="preserve">the SETUP method</doc>
  2628. </member>
  2629. <member name="set_parameter"
  2630. value="512"
  2631. c:identifier="GST_RTSP_SET_PARAMETER"
  2632. glib:nick="set-parameter">
  2633. <doc xml:space="preserve">the SET_PARAMETER method</doc>
  2634. </member>
  2635. <member name="teardown"
  2636. value="1024"
  2637. c:identifier="GST_RTSP_TEARDOWN"
  2638. glib:nick="teardown">
  2639. <doc xml:space="preserve">the TEARDOWN method</doc>
  2640. </member>
  2641. <member name="get"
  2642. value="2048"
  2643. c:identifier="GST_RTSP_GET"
  2644. glib:nick="get">
  2645. <doc xml:space="preserve">the GET method (HTTP).</doc>
  2646. </member>
  2647. <member name="post"
  2648. value="4096"
  2649. c:identifier="GST_RTSP_POST"
  2650. glib:nick="post">
  2651. <doc xml:space="preserve">the POST method (HTTP).</doc>
  2652. </member>
  2653. <function name="as_text" c:identifier="gst_rtsp_method_as_text">
  2654. <doc xml:space="preserve">Convert @method to a string.</doc>
  2655. <return-value transfer-ownership="none">
  2656. <doc xml:space="preserve">a string representation of @method.</doc>
  2657. <type name="utf8" c:type="const gchar*"/>
  2658. </return-value>
  2659. <parameters>
  2660. <parameter name="method" transfer-ownership="none">
  2661. <doc xml:space="preserve">a #GstRTSPMethod</doc>
  2662. <type name="RTSPMethod" c:type="GstRTSPMethod"/>
  2663. </parameter>
  2664. </parameters>
  2665. </function>
  2666. </bitfield>
  2667. <enumeration name="RTSPMsgType"
  2668. glib:type-name="GstRTSPMsgType"
  2669. glib:get-type="gst_rtsp_msg_type_get_type"
  2670. c:type="GstRTSPMsgType">
  2671. <doc xml:space="preserve">The type of a message.</doc>
  2672. <member name="invalid"
  2673. value="0"
  2674. c:identifier="GST_RTSP_MESSAGE_INVALID"
  2675. glib:nick="invalid">
  2676. <doc xml:space="preserve">invalid message type</doc>
  2677. </member>
  2678. <member name="request"
  2679. value="1"
  2680. c:identifier="GST_RTSP_MESSAGE_REQUEST"
  2681. glib:nick="request">
  2682. <doc xml:space="preserve">RTSP request message</doc>
  2683. </member>
  2684. <member name="response"
  2685. value="2"
  2686. c:identifier="GST_RTSP_MESSAGE_RESPONSE"
  2687. glib:nick="response">
  2688. <doc xml:space="preserve">RTSP response message</doc>
  2689. </member>
  2690. <member name="http_request"
  2691. value="3"
  2692. c:identifier="GST_RTSP_MESSAGE_HTTP_REQUEST"
  2693. glib:nick="http-request">
  2694. <doc xml:space="preserve">HTTP request message.</doc>
  2695. </member>
  2696. <member name="http_response"
  2697. value="4"
  2698. c:identifier="GST_RTSP_MESSAGE_HTTP_RESPONSE"
  2699. glib:nick="http-response">
  2700. <doc xml:space="preserve">HTTP response message.</doc>
  2701. </member>
  2702. <member name="data"
  2703. value="5"
  2704. c:identifier="GST_RTSP_MESSAGE_DATA"
  2705. glib:nick="data">
  2706. <doc xml:space="preserve">data message</doc>
  2707. </member>
  2708. </enumeration>
  2709. <bitfield name="RTSPProfile"
  2710. glib:type-name="GstRTSPProfile"
  2711. glib:get-type="gst_rtsp_profile_get_type"
  2712. c:type="GstRTSPProfile">
  2713. <doc xml:space="preserve">The transfer profile to use.</doc>
  2714. <member name="unknown"
  2715. value="0"
  2716. c:identifier="GST_RTSP_PROFILE_UNKNOWN"
  2717. glib:nick="unknown">
  2718. <doc xml:space="preserve">invalid profile</doc>
  2719. </member>
  2720. <member name="avp"
  2721. value="1"
  2722. c:identifier="GST_RTSP_PROFILE_AVP"
  2723. glib:nick="avp">
  2724. <doc xml:space="preserve">the Audio/Visual profile (RFC 3551)</doc>
  2725. </member>
  2726. <member name="savp"
  2727. value="2"
  2728. c:identifier="GST_RTSP_PROFILE_SAVP"
  2729. glib:nick="savp">
  2730. <doc xml:space="preserve">the secure Audio/Visual profile (RFC 3711)</doc>
  2731. </member>
  2732. <member name="avpf"
  2733. value="4"
  2734. c:identifier="GST_RTSP_PROFILE_AVPF"
  2735. glib:nick="avpf">
  2736. <doc xml:space="preserve">the Audio/Visual profile with feedback (RFC 4585)</doc>
  2737. </member>
  2738. <member name="savpf"
  2739. value="8"
  2740. c:identifier="GST_RTSP_PROFILE_SAVPF"
  2741. glib:nick="savpf">
  2742. <doc xml:space="preserve">the secure Audio/Visual profile with feedback (RFC 5124)</doc>
  2743. </member>
  2744. </bitfield>
  2745. <record name="RTSPRange" c:type="GstRTSPRange">
  2746. <doc xml:space="preserve">Provides helper functions to deal with time ranges.</doc>
  2747. <field name="min" writable="1">
  2748. <doc xml:space="preserve">minimum value of the range</doc>
  2749. <type name="gint" c:type="gint"/>
  2750. </field>
  2751. <field name="max" writable="1">
  2752. <doc xml:space="preserve">maximum value of the range</doc>
  2753. <type name="gint" c:type="gint"/>
  2754. </field>
  2755. <function name="convert_units"
  2756. c:identifier="gst_rtsp_range_convert_units">
  2757. <doc xml:space="preserve">Converts the range in-place between different types of units.
  2758. Ranges containing the special value #GST_RTSP_TIME_NOW can not be
  2759. converted as these are only valid for #GST_RTSP_RANGE_NPT.</doc>
  2760. <return-value transfer-ownership="none">
  2761. <doc xml:space="preserve">%TRUE if the range could be converted</doc>
  2762. <type name="gboolean" c:type="gboolean"/>
  2763. </return-value>
  2764. <parameters>
  2765. <parameter name="range" transfer-ownership="none">
  2766. <doc xml:space="preserve">a #GstRTSPTimeRange</doc>
  2767. <type name="RTSPTimeRange" c:type="GstRTSPTimeRange*"/>
  2768. </parameter>
  2769. <parameter name="unit" transfer-ownership="none">
  2770. <doc xml:space="preserve">the unit to convert the range into</doc>
  2771. <type name="RTSPRangeUnit" c:type="GstRTSPRangeUnit"/>
  2772. </parameter>
  2773. </parameters>
  2774. </function>
  2775. <function name="free" c:identifier="gst_rtsp_range_free">
  2776. <doc xml:space="preserve">Free the memory allocated by @range.</doc>
  2777. <return-value transfer-ownership="none">
  2778. <type name="none" c:type="void"/>
  2779. </return-value>
  2780. <parameters>
  2781. <parameter name="range" transfer-ownership="none">
  2782. <doc xml:space="preserve">a #GstRTSPTimeRange</doc>
  2783. <type name="RTSPTimeRange" c:type="GstRTSPTimeRange*"/>
  2784. </parameter>
  2785. </parameters>
  2786. </function>
  2787. <function name="get_times"
  2788. c:identifier="gst_rtsp_range_get_times"
  2789. version="1.2">
  2790. <doc xml:space="preserve">Retrieve the minimum and maximum values from @range converted to
  2791. #GstClockTime in @min and @max.
  2792. A value of %GST_CLOCK_TIME_NONE will be used to signal #GST_RTSP_TIME_NOW
  2793. and #GST_RTSP_TIME_END for @min and @max respectively.
  2794. UTC times will be converted to nanoseconds since 1900.</doc>
  2795. <return-value transfer-ownership="none">
  2796. <doc xml:space="preserve">%TRUE on success.</doc>
  2797. <type name="gboolean" c:type="gboolean"/>
  2798. </return-value>
  2799. <parameters>
  2800. <parameter name="range" transfer-ownership="none">
  2801. <doc xml:space="preserve">a #GstRTSPTimeRange</doc>
  2802. <type name="RTSPTimeRange" c:type="const GstRTSPTimeRange*"/>
  2803. </parameter>
  2804. <parameter name="min" transfer-ownership="none">
  2805. <doc xml:space="preserve">result minimum #GstClockTime</doc>
  2806. <type name="Gst.ClockTime" c:type="GstClockTime*"/>
  2807. </parameter>
  2808. <parameter name="max" transfer-ownership="none">
  2809. <doc xml:space="preserve">result maximum #GstClockTime</doc>
  2810. <type name="Gst.ClockTime" c:type="GstClockTime*"/>
  2811. </parameter>
  2812. </parameters>
  2813. </function>
  2814. <function name="parse" c:identifier="gst_rtsp_range_parse">
  2815. <doc xml:space="preserve">Parse @rangestr to a #GstRTSPTimeRange.</doc>
  2816. <return-value transfer-ownership="none">
  2817. <doc xml:space="preserve">#GST_RTSP_OK on success.</doc>
  2818. <type name="RTSPResult" c:type="GstRTSPResult"/>
  2819. </return-value>
  2820. <parameters>
  2821. <parameter name="rangestr" transfer-ownership="none">
  2822. <doc xml:space="preserve">a range string to parse</doc>
  2823. <type name="utf8" c:type="const gchar*"/>
  2824. </parameter>
  2825. <parameter name="range" transfer-ownership="none">
  2826. <doc xml:space="preserve">location to hold the #GstRTSPTimeRange result</doc>
  2827. <type name="RTSPTimeRange" c:type="GstRTSPTimeRange**"/>
  2828. </parameter>
  2829. </parameters>
  2830. </function>
  2831. <function name="to_string" c:identifier="gst_rtsp_range_to_string">
  2832. <doc xml:space="preserve">Convert @range into a string representation.</doc>
  2833. <return-value transfer-ownership="full">
  2834. <doc xml:space="preserve">The string representation of @range. g_free() after usage.</doc>
  2835. <type name="utf8" c:type="gchar*"/>
  2836. </return-value>
  2837. <parameters>
  2838. <parameter name="range" transfer-ownership="none">
  2839. <doc xml:space="preserve">a #GstRTSPTimeRange</doc>
  2840. <type name="RTSPTimeRange" c:type="const GstRTSPTimeRange*"/>
  2841. </parameter>
  2842. </parameters>
  2843. </function>
  2844. </record>
  2845. <enumeration name="RTSPRangeUnit"
  2846. glib:type-name="GstRTSPRangeUnit"
  2847. glib:get-type="gst_rtsp_range_unit_get_type"
  2848. c:type="GstRTSPRangeUnit">
  2849. <doc xml:space="preserve">Different possible time range units.</doc>
  2850. <member name="smpte"
  2851. value="0"
  2852. c:identifier="GST_RTSP_RANGE_SMPTE"
  2853. glib:nick="smpte">
  2854. <doc xml:space="preserve">SMPTE timecode</doc>
  2855. </member>
  2856. <member name="smpte_30_drop"
  2857. value="1"
  2858. c:identifier="GST_RTSP_RANGE_SMPTE_30_DROP"
  2859. glib:nick="smpte-30-drop">
  2860. <doc xml:space="preserve">29.97 frames per second</doc>
  2861. </member>
  2862. <member name="smpte_25"
  2863. value="2"
  2864. c:identifier="GST_RTSP_RANGE_SMPTE_25"
  2865. glib:nick="smpte-25">
  2866. <doc xml:space="preserve">25 frames per second</doc>
  2867. </member>
  2868. <member name="npt"
  2869. value="3"
  2870. c:identifier="GST_RTSP_RANGE_NPT"
  2871. glib:nick="npt">
  2872. <doc xml:space="preserve">Normal play time</doc>
  2873. </member>
  2874. <member name="clock"
  2875. value="4"
  2876. c:identifier="GST_RTSP_RANGE_CLOCK"
  2877. glib:nick="clock">
  2878. <doc xml:space="preserve">Absolute time expressed as ISO 8601 timestamps</doc>
  2879. </member>
  2880. </enumeration>
  2881. <enumeration name="RTSPResult"
  2882. glib:type-name="GstRTSPResult"
  2883. glib:get-type="gst_rtsp_result_get_type"
  2884. c:type="GstRTSPResult">
  2885. <doc xml:space="preserve">Result codes from the RTSP functions.</doc>
  2886. <member name="ok" value="0" c:identifier="GST_RTSP_OK" glib:nick="ok">
  2887. <doc xml:space="preserve">no error</doc>
  2888. </member>
  2889. <member name="error"
  2890. value="-1"
  2891. c:identifier="GST_RTSP_ERROR"
  2892. glib:nick="error">
  2893. <doc xml:space="preserve">some unspecified error occured</doc>
  2894. </member>
  2895. <member name="einval"
  2896. value="-2"
  2897. c:identifier="GST_RTSP_EINVAL"
  2898. glib:nick="einval">
  2899. <doc xml:space="preserve">invalid arguments were provided to a function</doc>
  2900. </member>
  2901. <member name="eintr"
  2902. value="-3"
  2903. c:identifier="GST_RTSP_EINTR"
  2904. glib:nick="eintr">
  2905. <doc xml:space="preserve">an operation was canceled</doc>
  2906. </member>
  2907. <member name="enomem"
  2908. value="-4"
  2909. c:identifier="GST_RTSP_ENOMEM"
  2910. glib:nick="enomem">
  2911. <doc xml:space="preserve">no memory was available for the operation</doc>
  2912. </member>
  2913. <member name="eresolv"
  2914. value="-5"
  2915. c:identifier="GST_RTSP_ERESOLV"
  2916. glib:nick="eresolv">
  2917. <doc xml:space="preserve">a host resolve error occured</doc>
  2918. </member>
  2919. <member name="enotimpl"
  2920. value="-6"
  2921. c:identifier="GST_RTSP_ENOTIMPL"
  2922. glib:nick="enotimpl">
  2923. <doc xml:space="preserve">function not implemented</doc>
  2924. </member>
  2925. <member name="esys"
  2926. value="-7"
  2927. c:identifier="GST_RTSP_ESYS"
  2928. glib:nick="esys">
  2929. <doc xml:space="preserve">a system error occured, errno contains more details</doc>
  2930. </member>
  2931. <member name="eparse"
  2932. value="-8"
  2933. c:identifier="GST_RTSP_EPARSE"
  2934. glib:nick="eparse">
  2935. <doc xml:space="preserve">a persing error occured</doc>
  2936. </member>
  2937. <member name="ewsastart"
  2938. value="-9"
  2939. c:identifier="GST_RTSP_EWSASTART"
  2940. glib:nick="ewsastart">
  2941. <doc xml:space="preserve">windows networking could not start</doc>
  2942. </member>
  2943. <member name="ewsaversion"
  2944. value="-10"
  2945. c:identifier="GST_RTSP_EWSAVERSION"
  2946. glib:nick="ewsaversion">
  2947. <doc xml:space="preserve">windows networking stack has wrong version</doc>
  2948. </member>
  2949. <member name="eeof"
  2950. value="-11"
  2951. c:identifier="GST_RTSP_EEOF"
  2952. glib:nick="eeof">
  2953. <doc xml:space="preserve">end-of-file was reached</doc>
  2954. </member>
  2955. <member name="enet"
  2956. value="-12"
  2957. c:identifier="GST_RTSP_ENET"
  2958. glib:nick="enet">
  2959. <doc xml:space="preserve">a network problem occured, h_errno contains more details</doc>
  2960. </member>
  2961. <member name="enotip"
  2962. value="-13"
  2963. c:identifier="GST_RTSP_ENOTIP"
  2964. glib:nick="enotip">
  2965. <doc xml:space="preserve">the host is not an IP host</doc>
  2966. </member>
  2967. <member name="etimeout"
  2968. value="-14"
  2969. c:identifier="GST_RTSP_ETIMEOUT"
  2970. glib:nick="etimeout">
  2971. <doc xml:space="preserve">a timeout occured</doc>
  2972. </member>
  2973. <member name="etget"
  2974. value="-15"
  2975. c:identifier="GST_RTSP_ETGET"
  2976. glib:nick="etget">
  2977. <doc xml:space="preserve">the tunnel GET request has been performed</doc>
  2978. </member>
  2979. <member name="etpost"
  2980. value="-16"
  2981. c:identifier="GST_RTSP_ETPOST"
  2982. glib:nick="etpost">
  2983. <doc xml:space="preserve">the tunnel POST request has been performed</doc>
  2984. </member>
  2985. <member name="elast"
  2986. value="-17"
  2987. c:identifier="GST_RTSP_ELAST"
  2988. glib:nick="elast">
  2989. <doc xml:space="preserve">last error</doc>
  2990. </member>
  2991. </enumeration>
  2992. <enumeration name="RTSPState"
  2993. glib:type-name="GstRTSPState"
  2994. glib:get-type="gst_rtsp_state_get_type"
  2995. c:type="GstRTSPState">
  2996. <doc xml:space="preserve">The different RTSP states.</doc>
  2997. <member name="invalid"
  2998. value="0"
  2999. c:identifier="GST_RTSP_STATE_INVALID"
  3000. glib:nick="invalid">
  3001. <doc xml:space="preserve">invalid state</doc>
  3002. </member>
  3003. <member name="init"
  3004. value="1"
  3005. c:identifier="GST_RTSP_STATE_INIT"
  3006. glib:nick="init">
  3007. <doc xml:space="preserve">initializing</doc>
  3008. </member>
  3009. <member name="ready"
  3010. value="2"
  3011. c:identifier="GST_RTSP_STATE_READY"
  3012. glib:nick="ready">
  3013. <doc xml:space="preserve">ready for operation</doc>
  3014. </member>
  3015. <member name="seeking"
  3016. value="3"
  3017. c:identifier="GST_RTSP_STATE_SEEKING"
  3018. glib:nick="seeking">
  3019. <doc xml:space="preserve">seeking in progress</doc>
  3020. </member>
  3021. <member name="playing"
  3022. value="4"
  3023. c:identifier="GST_RTSP_STATE_PLAYING"
  3024. glib:nick="playing">
  3025. <doc xml:space="preserve">playing</doc>
  3026. </member>
  3027. <member name="recording"
  3028. value="5"
  3029. c:identifier="GST_RTSP_STATE_RECORDING"
  3030. glib:nick="recording">
  3031. <doc xml:space="preserve">recording</doc>
  3032. </member>
  3033. </enumeration>
  3034. <enumeration name="RTSPStatusCode"
  3035. glib:type-name="GstRTSPStatusCode"
  3036. glib:get-type="gst_rtsp_status_code_get_type"
  3037. c:type="GstRTSPStatusCode">
  3038. <doc xml:space="preserve">Enumeration of rtsp status codes</doc>
  3039. <member name="invalid"
  3040. value="0"
  3041. c:identifier="GST_RTSP_STS_INVALID"
  3042. glib:nick="invalid">
  3043. </member>
  3044. <member name="continue"
  3045. value="100"
  3046. c:identifier="GST_RTSP_STS_CONTINUE"
  3047. glib:nick="continue">
  3048. </member>
  3049. <member name="ok"
  3050. value="200"
  3051. c:identifier="GST_RTSP_STS_OK"
  3052. glib:nick="ok">
  3053. </member>
  3054. <member name="created"
  3055. value="201"
  3056. c:identifier="GST_RTSP_STS_CREATED"
  3057. glib:nick="created">
  3058. </member>
  3059. <member name="low_on_storage"
  3060. value="250"
  3061. c:identifier="GST_RTSP_STS_LOW_ON_STORAGE"
  3062. glib:nick="low-on-storage">
  3063. </member>
  3064. <member name="multiple_choices"
  3065. value="300"
  3066. c:identifier="GST_RTSP_STS_MULTIPLE_CHOICES"
  3067. glib:nick="multiple-choices">
  3068. </member>
  3069. <member name="moved_permanently"
  3070. value="301"
  3071. c:identifier="GST_RTSP_STS_MOVED_PERMANENTLY"
  3072. glib:nick="moved-permanently">
  3073. </member>
  3074. <member name="move_temporarily"
  3075. value="302"
  3076. c:identifier="GST_RTSP_STS_MOVE_TEMPORARILY"
  3077. glib:nick="move-temporarily">
  3078. </member>
  3079. <member name="see_other"
  3080. value="303"
  3081. c:identifier="GST_RTSP_STS_SEE_OTHER"
  3082. glib:nick="see-other">
  3083. </member>
  3084. <member name="not_modified"
  3085. value="304"
  3086. c:identifier="GST_RTSP_STS_NOT_MODIFIED"
  3087. glib:nick="not-modified">
  3088. </member>
  3089. <member name="use_proxy"
  3090. value="305"
  3091. c:identifier="GST_RTSP_STS_USE_PROXY"
  3092. glib:nick="use-proxy">
  3093. </member>
  3094. <member name="bad_request"
  3095. value="400"
  3096. c:identifier="GST_RTSP_STS_BAD_REQUEST"
  3097. glib:nick="bad-request">
  3098. </member>
  3099. <member name="unauthorized"
  3100. value="401"
  3101. c:identifier="GST_RTSP_STS_UNAUTHORIZED"
  3102. glib:nick="unauthorized">
  3103. </member>
  3104. <member name="payment_required"
  3105. value="402"
  3106. c:identifier="GST_RTSP_STS_PAYMENT_REQUIRED"
  3107. glib:nick="payment-required">
  3108. </member>
  3109. <member name="forbidden"
  3110. value="403"
  3111. c:identifier="GST_RTSP_STS_FORBIDDEN"
  3112. glib:nick="forbidden">
  3113. </member>
  3114. <member name="not_found"
  3115. value="404"
  3116. c:identifier="GST_RTSP_STS_NOT_FOUND"
  3117. glib:nick="not-found">
  3118. </member>
  3119. <member name="method_not_allowed"
  3120. value="405"
  3121. c:identifier="GST_RTSP_STS_METHOD_NOT_ALLOWED"
  3122. glib:nick="method-not-allowed">
  3123. </member>
  3124. <member name="not_acceptable"
  3125. value="406"
  3126. c:identifier="GST_RTSP_STS_NOT_ACCEPTABLE"
  3127. glib:nick="not-acceptable">
  3128. </member>
  3129. <member name="proxy_auth_required"
  3130. value="407"
  3131. c:identifier="GST_RTSP_STS_PROXY_AUTH_REQUIRED"
  3132. glib:nick="proxy-auth-required">
  3133. </member>
  3134. <member name="request_timeout"
  3135. value="408"
  3136. c:identifier="GST_RTSP_STS_REQUEST_TIMEOUT"
  3137. glib:nick="request-timeout">
  3138. </member>
  3139. <member name="gone"
  3140. value="410"
  3141. c:identifier="GST_RTSP_STS_GONE"
  3142. glib:nick="gone">
  3143. </member>
  3144. <member name="length_required"
  3145. value="411"
  3146. c:identifier="GST_RTSP_STS_LENGTH_REQUIRED"
  3147. glib:nick="length-required">
  3148. </member>
  3149. <member name="precondition_failed"
  3150. value="412"
  3151. c:identifier="GST_RTSP_STS_PRECONDITION_FAILED"
  3152. glib:nick="precondition-failed">
  3153. </member>
  3154. <member name="request_entity_too_large"
  3155. value="413"
  3156. c:identifier="GST_RTSP_STS_REQUEST_ENTITY_TOO_LARGE"
  3157. glib:nick="request-entity-too-large">
  3158. </member>
  3159. <member name="request_uri_too_large"
  3160. value="414"
  3161. c:identifier="GST_RTSP_STS_REQUEST_URI_TOO_LARGE"
  3162. glib:nick="request-uri-too-large">
  3163. </member>
  3164. <member name="unsupported_media_type"
  3165. value="415"
  3166. c:identifier="GST_RTSP_STS_UNSUPPORTED_MEDIA_TYPE"
  3167. glib:nick="unsupported-media-type">
  3168. </member>
  3169. <member name="parameter_not_understood"
  3170. value="451"
  3171. c:identifier="GST_RTSP_STS_PARAMETER_NOT_UNDERSTOOD"
  3172. glib:nick="parameter-not-understood">
  3173. </member>
  3174. <member name="conference_not_found"
  3175. value="452"
  3176. c:identifier="GST_RTSP_STS_CONFERENCE_NOT_FOUND"
  3177. glib:nick="conference-not-found">
  3178. </member>
  3179. <member name="not_enough_bandwidth"
  3180. value="453"
  3181. c:identifier="GST_RTSP_STS_NOT_ENOUGH_BANDWIDTH"
  3182. glib:nick="not-enough-bandwidth">
  3183. </member>
  3184. <member name="session_not_found"
  3185. value="454"
  3186. c:identifier="GST_RTSP_STS_SESSION_NOT_FOUND"
  3187. glib:nick="session-not-found">
  3188. </member>
  3189. <member name="method_not_valid_in_this_state"
  3190. value="455"
  3191. c:identifier="GST_RTSP_STS_METHOD_NOT_VALID_IN_THIS_STATE"
  3192. glib:nick="method-not-valid-in-this-state">
  3193. </member>
  3194. <member name="header_field_not_valid_for_resource"
  3195. value="456"
  3196. c:identifier="GST_RTSP_STS_HEADER_FIELD_NOT_VALID_FOR_RESOURCE"
  3197. glib:nick="header-field-not-valid-for-resource">
  3198. </member>
  3199. <member name="invalid_range"
  3200. value="457"
  3201. c:identifier="GST_RTSP_STS_INVALID_RANGE"
  3202. glib:nick="invalid-range">
  3203. </member>
  3204. <member name="parameter_is_readonly"
  3205. value="458"
  3206. c:identifier="GST_RTSP_STS_PARAMETER_IS_READONLY"
  3207. glib:nick="parameter-is-readonly">
  3208. </member>
  3209. <member name="aggregate_operation_not_allowed"
  3210. value="459"
  3211. c:identifier="GST_RTSP_STS_AGGREGATE_OPERATION_NOT_ALLOWED"
  3212. glib:nick="aggregate-operation-not-allowed">
  3213. </member>
  3214. <member name="only_aggregate_operation_allowed"
  3215. value="460"
  3216. c:identifier="GST_RTSP_STS_ONLY_AGGREGATE_OPERATION_ALLOWED"
  3217. glib:nick="only-aggregate-operation-allowed">
  3218. </member>
  3219. <member name="unsupported_transport"
  3220. value="461"
  3221. c:identifier="GST_RTSP_STS_UNSUPPORTED_TRANSPORT"
  3222. glib:nick="unsupported-transport">
  3223. </member>
  3224. <member name="destination_unreachable"
  3225. value="462"
  3226. c:identifier="GST_RTSP_STS_DESTINATION_UNREACHABLE"
  3227. glib:nick="destination-unreachable">
  3228. </member>
  3229. <member name="key_management_failure"
  3230. value="463"
  3231. c:identifier="GST_RTSP_STS_KEY_MANAGEMENT_FAILURE"
  3232. glib:nick="key-management-failure">
  3233. </member>
  3234. <member name="internal_server_error"
  3235. value="500"
  3236. c:identifier="GST_RTSP_STS_INTERNAL_SERVER_ERROR"
  3237. glib:nick="internal-server-error">
  3238. </member>
  3239. <member name="not_implemented"
  3240. value="501"
  3241. c:identifier="GST_RTSP_STS_NOT_IMPLEMENTED"
  3242. glib:nick="not-implemented">
  3243. </member>
  3244. <member name="bad_gateway"
  3245. value="502"
  3246. c:identifier="GST_RTSP_STS_BAD_GATEWAY"
  3247. glib:nick="bad-gateway">
  3248. </member>
  3249. <member name="service_unavailable"
  3250. value="503"
  3251. c:identifier="GST_RTSP_STS_SERVICE_UNAVAILABLE"
  3252. glib:nick="service-unavailable">
  3253. </member>
  3254. <member name="gateway_timeout"
  3255. value="504"
  3256. c:identifier="GST_RTSP_STS_GATEWAY_TIMEOUT"
  3257. glib:nick="gateway-timeout">
  3258. </member>
  3259. <member name="rtsp_version_not_supported"
  3260. value="505"
  3261. c:identifier="GST_RTSP_STS_RTSP_VERSION_NOT_SUPPORTED"
  3262. glib:nick="rtsp-version-not-supported">
  3263. </member>
  3264. <member name="option_not_supported"
  3265. value="551"
  3266. c:identifier="GST_RTSP_STS_OPTION_NOT_SUPPORTED"
  3267. glib:nick="option-not-supported">
  3268. </member>
  3269. </enumeration>
  3270. <record name="RTSPTime" c:type="GstRTSPTime">
  3271. <doc xml:space="preserve">A time indication.</doc>
  3272. <field name="type" writable="1">
  3273. <doc xml:space="preserve">the time of the time</doc>
  3274. <type name="RTSPTimeType" c:type="GstRTSPTimeType"/>
  3275. </field>
  3276. <field name="seconds" writable="1">
  3277. <doc xml:space="preserve">seconds when @type is GST_RTSP_TIME_SECONDS,
  3278. GST_RTSP_TIME_UTC and GST_RTSP_TIME_FRAMES</doc>
  3279. <type name="gdouble" c:type="gdouble"/>
  3280. </field>
  3281. </record>
  3282. <record name="RTSPTime2" c:type="GstRTSPTime2" version="1.2">
  3283. <doc xml:space="preserve">Extra fields for a time indication.</doc>
  3284. <field name="frames" writable="1">
  3285. <doc xml:space="preserve">frames and subframes when type in GstRTSPTime is
  3286. GST_RTSP_TIME_FRAMES</doc>
  3287. <type name="gdouble" c:type="gdouble"/>
  3288. </field>
  3289. <field name="year" writable="1">
  3290. <doc xml:space="preserve">year when type is GST_RTSP_TIME_UTC</doc>
  3291. <type name="guint" c:type="guint"/>
  3292. </field>
  3293. <field name="month" writable="1">
  3294. <doc xml:space="preserve">month when type is GST_RTSP_TIME_UTC</doc>
  3295. <type name="guint" c:type="guint"/>
  3296. </field>
  3297. <field name="day" writable="1">
  3298. <doc xml:space="preserve">day when type is GST_RTSP_TIME_UTC</doc>
  3299. <type name="guint" c:type="guint"/>
  3300. </field>
  3301. </record>
  3302. <record name="RTSPTimeRange" c:type="GstRTSPTimeRange">
  3303. <doc xml:space="preserve">A time range.</doc>
  3304. <field name="unit" writable="1">
  3305. <doc xml:space="preserve">the time units used</doc>
  3306. <type name="RTSPRangeUnit" c:type="GstRTSPRangeUnit"/>
  3307. </field>
  3308. <field name="min" writable="1">
  3309. <doc xml:space="preserve">the minimum interval</doc>
  3310. <type name="RTSPTime" c:type="GstRTSPTime"/>
  3311. </field>
  3312. <field name="max" writable="1">
  3313. <doc xml:space="preserve">the maximum interval</doc>
  3314. <type name="RTSPTime" c:type="GstRTSPTime"/>
  3315. </field>
  3316. <field name="min2" writable="1">
  3317. <doc xml:space="preserve">extra fields in the minimum interval (Since: 1.2)</doc>
  3318. <type name="RTSPTime2" c:type="GstRTSPTime2"/>
  3319. </field>
  3320. <field name="max2" writable="1">
  3321. <doc xml:space="preserve">extra fields in the maximum interval (Since: 1.2)</doc>
  3322. <type name="RTSPTime2" c:type="GstRTSPTime2"/>
  3323. </field>
  3324. </record>
  3325. <enumeration name="RTSPTimeType"
  3326. glib:type-name="GstRTSPTimeType"
  3327. glib:get-type="gst_rtsp_time_type_get_type"
  3328. c:type="GstRTSPTimeType">
  3329. <doc xml:space="preserve">Possible time types.</doc>
  3330. <member name="seconds"
  3331. value="0"
  3332. c:identifier="GST_RTSP_TIME_SECONDS"
  3333. glib:nick="seconds">
  3334. <doc xml:space="preserve">seconds</doc>
  3335. </member>
  3336. <member name="now"
  3337. value="1"
  3338. c:identifier="GST_RTSP_TIME_NOW"
  3339. glib:nick="now">
  3340. <doc xml:space="preserve">now</doc>
  3341. </member>
  3342. <member name="end"
  3343. value="2"
  3344. c:identifier="GST_RTSP_TIME_END"
  3345. glib:nick="end">
  3346. <doc xml:space="preserve">end</doc>
  3347. </member>
  3348. <member name="frames"
  3349. value="3"
  3350. c:identifier="GST_RTSP_TIME_FRAMES"
  3351. glib:nick="frames">
  3352. <doc xml:space="preserve">frames and subframes</doc>
  3353. </member>
  3354. <member name="utc"
  3355. value="4"
  3356. c:identifier="GST_RTSP_TIME_UTC"
  3357. glib:nick="utc">
  3358. <doc xml:space="preserve">UTC time</doc>
  3359. </member>
  3360. </enumeration>
  3361. <bitfield name="RTSPTransMode"
  3362. glib:type-name="GstRTSPTransMode"
  3363. glib:get-type="gst_rtsp_trans_mode_get_type"
  3364. c:type="GstRTSPTransMode">
  3365. <doc xml:space="preserve">The transfer mode to use.</doc>
  3366. <member name="unknown"
  3367. value="0"
  3368. c:identifier="GST_RTSP_TRANS_UNKNOWN"
  3369. glib:nick="unknown">
  3370. <doc xml:space="preserve">invalid tansport mode</doc>
  3371. </member>
  3372. <member name="rtp"
  3373. value="1"
  3374. c:identifier="GST_RTSP_TRANS_RTP"
  3375. glib:nick="rtp">
  3376. <doc xml:space="preserve">transfer RTP data</doc>
  3377. </member>
  3378. <member name="rdt"
  3379. value="2"
  3380. c:identifier="GST_RTSP_TRANS_RDT"
  3381. glib:nick="rdt">
  3382. <doc xml:space="preserve">transfer RDT (RealMedia) data</doc>
  3383. </member>
  3384. </bitfield>
  3385. <record name="RTSPTransport" c:type="GstRTSPTransport">
  3386. <doc xml:space="preserve">Provides helper functions to deal with RTSP transport strings.</doc>
  3387. <field name="trans" writable="1">
  3388. <doc xml:space="preserve">the transport mode</doc>
  3389. <type name="RTSPTransMode" c:type="GstRTSPTransMode"/>
  3390. </field>
  3391. <field name="profile" writable="1">
  3392. <doc xml:space="preserve">the tansport profile</doc>
  3393. <type name="RTSPProfile" c:type="GstRTSPProfile"/>
  3394. </field>
  3395. <field name="lower_transport" writable="1">
  3396. <doc xml:space="preserve">the lower transport</doc>
  3397. <type name="RTSPLowerTrans" c:type="GstRTSPLowerTrans"/>
  3398. </field>
  3399. <field name="destination" writable="1">
  3400. <doc xml:space="preserve">the destination ip/hostname</doc>
  3401. <type name="utf8" c:type="gchar*"/>
  3402. </field>
  3403. <field name="source" writable="1">
  3404. <doc xml:space="preserve">the source ip/hostname</doc>
  3405. <type name="utf8" c:type="gchar*"/>
  3406. </field>
  3407. <field name="layers" writable="1">
  3408. <doc xml:space="preserve">the number of layers</doc>
  3409. <type name="guint" c:type="guint"/>
  3410. </field>
  3411. <field name="mode_play" writable="1">
  3412. <doc xml:space="preserve">if play mode was selected</doc>
  3413. <type name="gboolean" c:type="gboolean"/>
  3414. </field>
  3415. <field name="mode_record" writable="1">
  3416. <doc xml:space="preserve">if record mode was selected</doc>
  3417. <type name="gboolean" c:type="gboolean"/>
  3418. </field>
  3419. <field name="append" writable="1">
  3420. <doc xml:space="preserve">is append mode was selected</doc>
  3421. <type name="gboolean" c:type="gboolean"/>
  3422. </field>
  3423. <field name="interleaved" writable="1">
  3424. <doc xml:space="preserve">the interleave range</doc>
  3425. <type name="RTSPRange" c:type="GstRTSPRange"/>
  3426. </field>
  3427. <field name="ttl" writable="1">
  3428. <doc xml:space="preserve">the time to live for multicast UDP</doc>
  3429. <type name="guint" c:type="guint"/>
  3430. </field>
  3431. <field name="port" writable="1">
  3432. <doc xml:space="preserve">the port pair for multicast sessions</doc>
  3433. <type name="RTSPRange" c:type="GstRTSPRange"/>
  3434. </field>
  3435. <field name="client_port" writable="1">
  3436. <doc xml:space="preserve">the client port pair for receiving data. For TCP
  3437. based transports, applications can use this field to store the
  3438. sender and receiver ports of the client.</doc>
  3439. <type name="RTSPRange" c:type="GstRTSPRange"/>
  3440. </field>
  3441. <field name="server_port" writable="1">
  3442. <doc xml:space="preserve">the server port pair for receiving data. For TCP
  3443. based transports, applications can use this field to store the
  3444. sender and receiver ports of the server.</doc>
  3445. <type name="RTSPRange" c:type="GstRTSPRange"/>
  3446. </field>
  3447. <field name="ssrc" writable="1">
  3448. <doc xml:space="preserve">the ssrc that the sender/receiver will use</doc>
  3449. <type name="guint" c:type="guint"/>
  3450. </field>
  3451. <field name="_gst_reserved" readable="0" private="1">
  3452. <array zero-terminated="0" c:type="gpointer" fixed-size="4">
  3453. <type name="gpointer" c:type="gpointer"/>
  3454. </array>
  3455. </field>
  3456. <method name="as_text" c:identifier="gst_rtsp_transport_as_text">
  3457. <doc xml:space="preserve">Convert @transport into a string that can be used to signal the transport in
  3458. an RTSP SETUP response.</doc>
  3459. <return-value transfer-ownership="full">
  3460. <doc xml:space="preserve">a string describing the RTSP transport or #NULL when the transport
  3461. is invalid.</doc>
  3462. <type name="utf8" c:type="gchar*"/>
  3463. </return-value>
  3464. <parameters>
  3465. <instance-parameter name="transport" transfer-ownership="none">
  3466. <doc xml:space="preserve">a #GstRTSPTransport</doc>
  3467. <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
  3468. </instance-parameter>
  3469. </parameters>
  3470. </method>
  3471. <method name="free" c:identifier="gst_rtsp_transport_free">
  3472. <doc xml:space="preserve">Free the memory used by @transport.</doc>
  3473. <return-value transfer-ownership="none">
  3474. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  3475. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3476. </return-value>
  3477. <parameters>
  3478. <instance-parameter name="transport" transfer-ownership="none">
  3479. <doc xml:space="preserve">a #GstRTSPTransport</doc>
  3480. <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
  3481. </instance-parameter>
  3482. </parameters>
  3483. </method>
  3484. <method name="get_media_type"
  3485. c:identifier="gst_rtsp_transport_get_media_type"
  3486. version="1.4">
  3487. <doc xml:space="preserve">Get the media type of @transport. This media type is typically
  3488. used to generate #GstCaps events.</doc>
  3489. <return-value transfer-ownership="none">
  3490. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  3491. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3492. </return-value>
  3493. <parameters>
  3494. <instance-parameter name="transport" transfer-ownership="none">
  3495. <doc xml:space="preserve">a #GstRTSPTransport</doc>
  3496. <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
  3497. </instance-parameter>
  3498. <parameter name="media_type"
  3499. direction="out"
  3500. caller-allocates="0"
  3501. transfer-ownership="none">
  3502. <doc xml:space="preserve">media type of @transport</doc>
  3503. <type name="utf8" c:type="const gchar**"/>
  3504. </parameter>
  3505. </parameters>
  3506. </method>
  3507. <method name="init" c:identifier="gst_rtsp_transport_init">
  3508. <doc xml:space="preserve">Initialize @transport so that it can be used.</doc>
  3509. <return-value transfer-ownership="none">
  3510. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  3511. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3512. </return-value>
  3513. <parameters>
  3514. <instance-parameter name="transport" transfer-ownership="none">
  3515. <doc xml:space="preserve">a #GstRTSPTransport</doc>
  3516. <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
  3517. </instance-parameter>
  3518. </parameters>
  3519. </method>
  3520. <function name="get_manager"
  3521. c:identifier="gst_rtsp_transport_get_manager">
  3522. <doc xml:space="preserve">Get the #GstElement that can handle the buffers transported over @trans.
  3523. It is possible that there are several managers available, use @option to
  3524. selected one.
  3525. @manager will contain an element name or #NULL when no manager is
  3526. needed/available for @trans.</doc>
  3527. <return-value transfer-ownership="none">
  3528. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  3529. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3530. </return-value>
  3531. <parameters>
  3532. <parameter name="trans" transfer-ownership="none">
  3533. <doc xml:space="preserve">a #GstRTSPTransMode</doc>
  3534. <type name="RTSPTransMode" c:type="GstRTSPTransMode"/>
  3535. </parameter>
  3536. <parameter name="manager" transfer-ownership="none">
  3537. <doc xml:space="preserve">location to hold the result</doc>
  3538. <type name="utf8" c:type="const gchar**"/>
  3539. </parameter>
  3540. <parameter name="option" transfer-ownership="none">
  3541. <doc xml:space="preserve">option index.</doc>
  3542. <type name="guint" c:type="guint"/>
  3543. </parameter>
  3544. </parameters>
  3545. </function>
  3546. <function name="get_mime"
  3547. c:identifier="gst_rtsp_transport_get_mime"
  3548. deprecated="1">
  3549. <doc xml:space="preserve">Get the mime type of the transport mode @trans. This mime type is typically
  3550. used to generate #GstCaps events.</doc>
  3551. <doc-deprecated xml:space="preserve">This functions only deals with the GstRTSPTransMode and only
  3552. returns the mime type for #GST_RTSP_PROFILE_AVP. Use
  3553. gst_rtsp_transport_get_media_type() instead.</doc-deprecated>
  3554. <return-value transfer-ownership="none">
  3555. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  3556. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3557. </return-value>
  3558. <parameters>
  3559. <parameter name="trans" transfer-ownership="none">
  3560. <doc xml:space="preserve">a #GstRTSPTransMode</doc>
  3561. <type name="RTSPTransMode" c:type="GstRTSPTransMode"/>
  3562. </parameter>
  3563. <parameter name="mime" transfer-ownership="none">
  3564. <doc xml:space="preserve">location to hold the result</doc>
  3565. <type name="utf8" c:type="const gchar**"/>
  3566. </parameter>
  3567. </parameters>
  3568. </function>
  3569. <function name="new" c:identifier="gst_rtsp_transport_new">
  3570. <doc xml:space="preserve">Allocate a new initialized #GstRTSPTransport. Use gst_rtsp_transport_free()
  3571. after usage.</doc>
  3572. <return-value transfer-ownership="none">
  3573. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  3574. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3575. </return-value>
  3576. <parameters>
  3577. <parameter name="transport" transfer-ownership="none">
  3578. <doc xml:space="preserve">location to hold the new #GstRTSPTransport</doc>
  3579. <type name="RTSPTransport" c:type="GstRTSPTransport**"/>
  3580. </parameter>
  3581. </parameters>
  3582. </function>
  3583. <function name="parse" c:identifier="gst_rtsp_transport_parse">
  3584. <doc xml:space="preserve">Parse the RTSP transport string @str into @transport.</doc>
  3585. <return-value transfer-ownership="none">
  3586. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  3587. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3588. </return-value>
  3589. <parameters>
  3590. <parameter name="str" transfer-ownership="none">
  3591. <doc xml:space="preserve">a transport string</doc>
  3592. <type name="utf8" c:type="const gchar*"/>
  3593. </parameter>
  3594. <parameter name="transport" transfer-ownership="none">
  3595. <doc xml:space="preserve">a #GstRTSPTransport</doc>
  3596. <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
  3597. </parameter>
  3598. </parameters>
  3599. </function>
  3600. </record>
  3601. <record name="RTSPUrl"
  3602. c:type="GstRTSPUrl"
  3603. glib:type-name="GstRTSPUrl"
  3604. glib:get-type="gst_rtsp_url_get_type"
  3605. c:symbol-prefix="rtsp_url">
  3606. <doc xml:space="preserve">Provides helper functions to handle RTSP urls.</doc>
  3607. <field name="transports" writable="1">
  3608. <doc xml:space="preserve">the transports allowed</doc>
  3609. <type name="RTSPLowerTrans" c:type="GstRTSPLowerTrans"/>
  3610. </field>
  3611. <field name="family" writable="1">
  3612. <doc xml:space="preserve">the family</doc>
  3613. <type name="RTSPFamily" c:type="GstRTSPFamily"/>
  3614. </field>
  3615. <field name="user" writable="1">
  3616. <doc xml:space="preserve">the user</doc>
  3617. <type name="utf8" c:type="gchar*"/>
  3618. </field>
  3619. <field name="passwd" writable="1">
  3620. <doc xml:space="preserve">the password</doc>
  3621. <type name="utf8" c:type="gchar*"/>
  3622. </field>
  3623. <field name="host" writable="1">
  3624. <doc xml:space="preserve">the host</doc>
  3625. <type name="utf8" c:type="gchar*"/>
  3626. </field>
  3627. <field name="port" writable="1">
  3628. <doc xml:space="preserve">the port</doc>
  3629. <type name="guint16" c:type="guint16"/>
  3630. </field>
  3631. <field name="abspath" writable="1">
  3632. <doc xml:space="preserve">the absolute path</doc>
  3633. <type name="utf8" c:type="gchar*"/>
  3634. </field>
  3635. <field name="query" writable="1">
  3636. <doc xml:space="preserve">additional query parameters</doc>
  3637. <type name="utf8" c:type="gchar*"/>
  3638. </field>
  3639. <method name="copy" c:identifier="gst_rtsp_url_copy">
  3640. <doc xml:space="preserve">Make a copy of @url.</doc>
  3641. <return-value transfer-ownership="full">
  3642. <doc xml:space="preserve">a copy of @url. Free with gst_rtsp_url_free () after usage.</doc>
  3643. <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
  3644. </return-value>
  3645. <parameters>
  3646. <instance-parameter name="url" transfer-ownership="none">
  3647. <doc xml:space="preserve">a #GstRTSPUrl</doc>
  3648. <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
  3649. </instance-parameter>
  3650. </parameters>
  3651. </method>
  3652. <method name="decode_path_components"
  3653. c:identifier="gst_rtsp_url_decode_path_components">
  3654. <doc xml:space="preserve">Splits the path of @url on '/' boundaries, decoding the resulting components,
  3655. The decoding performed by this routine is "URI decoding", as defined in RFC
  3656. 3986, commonly known as percent-decoding. For example, a string "foo\%2fbar"
  3657. will decode to "foo/bar" -- the \%2f being replaced by the corresponding byte
  3658. with hex value 0x2f. Note that there is no guarantee that the resulting byte
  3659. sequence is valid in any given encoding. As a special case, \%00 is not
  3660. unescaped to NUL, as that would prematurely terminate the string.
  3661. Also note that since paths usually start with a slash, the first component
  3662. will usually be the empty string.</doc>
  3663. <return-value transfer-ownership="full">
  3664. <doc xml:space="preserve">%NULL-terminated array of URL components. Free with
  3665. g_strfreev() when no longer needed.</doc>
  3666. <array c:type="gchar**">
  3667. <type name="utf8"/>
  3668. </array>
  3669. </return-value>
  3670. <parameters>
  3671. <instance-parameter name="url" transfer-ownership="none">
  3672. <doc xml:space="preserve">a #GstRTSPUrl</doc>
  3673. <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
  3674. </instance-parameter>
  3675. </parameters>
  3676. </method>
  3677. <method name="free" c:identifier="gst_rtsp_url_free">
  3678. <doc xml:space="preserve">Free the memory used by @url.</doc>
  3679. <return-value transfer-ownership="none">
  3680. <type name="none" c:type="void"/>
  3681. </return-value>
  3682. <parameters>
  3683. <instance-parameter name="url" transfer-ownership="none">
  3684. <doc xml:space="preserve">a #GstRTSPUrl</doc>
  3685. <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
  3686. </instance-parameter>
  3687. </parameters>
  3688. </method>
  3689. <method name="get_port" c:identifier="gst_rtsp_url_get_port">
  3690. <doc xml:space="preserve">Get the port number of @url.</doc>
  3691. <return-value transfer-ownership="none">
  3692. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  3693. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3694. </return-value>
  3695. <parameters>
  3696. <instance-parameter name="url" transfer-ownership="none">
  3697. <doc xml:space="preserve">a #GstRTSPUrl</doc>
  3698. <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
  3699. </instance-parameter>
  3700. <parameter name="port" transfer-ownership="none">
  3701. <doc xml:space="preserve">location to hold the port</doc>
  3702. <type name="guint16" c:type="guint16*"/>
  3703. </parameter>
  3704. </parameters>
  3705. </method>
  3706. <method name="get_request_uri"
  3707. c:identifier="gst_rtsp_url_get_request_uri">
  3708. <doc xml:space="preserve">Get a newly allocated string describing the request URI for @url.</doc>
  3709. <return-value transfer-ownership="full">
  3710. <doc xml:space="preserve">a string with the request URI. g_free() after usage.</doc>
  3711. <type name="utf8" c:type="gchar*"/>
  3712. </return-value>
  3713. <parameters>
  3714. <instance-parameter name="url" transfer-ownership="none">
  3715. <doc xml:space="preserve">a #GstRTSPUrl</doc>
  3716. <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
  3717. </instance-parameter>
  3718. </parameters>
  3719. </method>
  3720. <method name="set_port" c:identifier="gst_rtsp_url_set_port">
  3721. <doc xml:space="preserve">Set the port number in @url to @port.</doc>
  3722. <return-value transfer-ownership="none">
  3723. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  3724. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3725. </return-value>
  3726. <parameters>
  3727. <instance-parameter name="url" transfer-ownership="none">
  3728. <doc xml:space="preserve">a #GstRTSPUrl</doc>
  3729. <type name="RTSPUrl" c:type="GstRTSPUrl*"/>
  3730. </instance-parameter>
  3731. <parameter name="port" transfer-ownership="none">
  3732. <doc xml:space="preserve">the port</doc>
  3733. <type name="guint16" c:type="guint16"/>
  3734. </parameter>
  3735. </parameters>
  3736. </method>
  3737. <function name="parse" c:identifier="gst_rtsp_url_parse">
  3738. <doc xml:space="preserve">Parse the RTSP @urlstr into a newly allocated #GstRTSPUrl. Free after usage
  3739. with gst_rtsp_url_free().</doc>
  3740. <return-value transfer-ownership="none">
  3741. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  3742. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3743. </return-value>
  3744. <parameters>
  3745. <parameter name="urlstr" transfer-ownership="none">
  3746. <doc xml:space="preserve">the url string to parse</doc>
  3747. <type name="utf8" c:type="const gchar*"/>
  3748. </parameter>
  3749. <parameter name="url"
  3750. direction="out"
  3751. caller-allocates="0"
  3752. transfer-ownership="full">
  3753. <doc xml:space="preserve">location to hold the result.</doc>
  3754. <type name="RTSPUrl" c:type="GstRTSPUrl**"/>
  3755. </parameter>
  3756. </parameters>
  3757. </function>
  3758. </record>
  3759. <enumeration name="RTSPVersion"
  3760. glib:type-name="GstRTSPVersion"
  3761. glib:get-type="gst_rtsp_version_get_type"
  3762. c:type="GstRTSPVersion">
  3763. <doc xml:space="preserve">The supported RTSP versions.</doc>
  3764. <member name="invalid"
  3765. value="0"
  3766. c:identifier="GST_RTSP_VERSION_INVALID"
  3767. glib:nick="invalid">
  3768. <doc xml:space="preserve">unknown/invalid version</doc>
  3769. </member>
  3770. <member name="1_0"
  3771. value="16"
  3772. c:identifier="GST_RTSP_VERSION_1_0"
  3773. glib:nick="1-0">
  3774. <doc xml:space="preserve">version 1.0</doc>
  3775. </member>
  3776. <member name="1_1"
  3777. value="17"
  3778. c:identifier="GST_RTSP_VERSION_1_1"
  3779. glib:nick="1-1">
  3780. <doc xml:space="preserve">version 1.1.</doc>
  3781. </member>
  3782. <function name="as_text" c:identifier="gst_rtsp_version_as_text">
  3783. <doc xml:space="preserve">Convert @version to a string.</doc>
  3784. <return-value transfer-ownership="none">
  3785. <doc xml:space="preserve">a string representation of @version.</doc>
  3786. <type name="utf8" c:type="const gchar*"/>
  3787. </return-value>
  3788. <parameters>
  3789. <parameter name="version" transfer-ownership="none">
  3790. <doc xml:space="preserve">a #GstRTSPVersion</doc>
  3791. <type name="RTSPVersion" c:type="GstRTSPVersion"/>
  3792. </parameter>
  3793. </parameters>
  3794. </function>
  3795. </enumeration>
  3796. <record name="RTSPWatch" c:type="GstRTSPWatch" disguised="1">
  3797. <doc xml:space="preserve">Opaque RTSP watch object that can be used for asynchronous RTSP
  3798. operations.</doc>
  3799. <method name="attach" c:identifier="gst_rtsp_watch_attach">
  3800. <doc xml:space="preserve">Adds a #GstRTSPWatch to a context so that it will be executed within that context.</doc>
  3801. <return-value transfer-ownership="none">
  3802. <doc xml:space="preserve">the ID (greater than 0) for the watch within the GMainContext.</doc>
  3803. <type name="guint" c:type="guint"/>
  3804. </return-value>
  3805. <parameters>
  3806. <instance-parameter name="watch" transfer-ownership="none">
  3807. <doc xml:space="preserve">a #GstRTSPWatch</doc>
  3808. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  3809. </instance-parameter>
  3810. <parameter name="context" transfer-ownership="none">
  3811. <doc xml:space="preserve">a GMainContext (if NULL, the default context will be used)</doc>
  3812. <type name="GLib.MainContext" c:type="GMainContext*"/>
  3813. </parameter>
  3814. </parameters>
  3815. </method>
  3816. <method name="get_send_backlog"
  3817. c:identifier="gst_rtsp_watch_get_send_backlog"
  3818. version="1.2">
  3819. <doc xml:space="preserve">Get the maximum amount of bytes and messages that will be queued in @watch.
  3820. See gst_rtsp_watch_set_send_backlog().</doc>
  3821. <return-value transfer-ownership="none">
  3822. <type name="none" c:type="void"/>
  3823. </return-value>
  3824. <parameters>
  3825. <instance-parameter name="watch" transfer-ownership="none">
  3826. <doc xml:space="preserve">a #GstRTSPWatch</doc>
  3827. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  3828. </instance-parameter>
  3829. <parameter name="bytes"
  3830. direction="out"
  3831. caller-allocates="0"
  3832. transfer-ownership="full"
  3833. optional="1"
  3834. allow-none="1">
  3835. <doc xml:space="preserve">maximum bytes</doc>
  3836. <type name="gsize" c:type="gsize*"/>
  3837. </parameter>
  3838. <parameter name="messages"
  3839. direction="out"
  3840. caller-allocates="0"
  3841. transfer-ownership="full"
  3842. optional="1"
  3843. allow-none="1">
  3844. <doc xml:space="preserve">maximum messages</doc>
  3845. <type name="guint" c:type="guint*"/>
  3846. </parameter>
  3847. </parameters>
  3848. </method>
  3849. <method name="reset" c:identifier="gst_rtsp_watch_reset">
  3850. <doc xml:space="preserve">Reset @watch, this is usually called after gst_rtsp_connection_do_tunnel()
  3851. when the file descriptors of the connection might have changed.</doc>
  3852. <return-value transfer-ownership="none">
  3853. <type name="none" c:type="void"/>
  3854. </return-value>
  3855. <parameters>
  3856. <instance-parameter name="watch" transfer-ownership="none">
  3857. <doc xml:space="preserve">a #GstRTSPWatch</doc>
  3858. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  3859. </instance-parameter>
  3860. </parameters>
  3861. </method>
  3862. <method name="send_message" c:identifier="gst_rtsp_watch_send_message">
  3863. <doc xml:space="preserve">Send a @message using the connection of the @watch. If it cannot be sent
  3864. immediately, it will be queued for transmission in @watch. The contents of
  3865. @message will then be serialized and transmitted when the connection of the
  3866. @watch becomes writable. In case the @message is queued, the ID returned in
  3867. @id will be non-zero and used as the ID argument in the message_sent
  3868. callback.</doc>
  3869. <return-value transfer-ownership="none">
  3870. <doc xml:space="preserve">#GST_RTSP_OK on success.</doc>
  3871. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3872. </return-value>
  3873. <parameters>
  3874. <instance-parameter name="watch" transfer-ownership="none">
  3875. <doc xml:space="preserve">a #GstRTSPWatch</doc>
  3876. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  3877. </instance-parameter>
  3878. <parameter name="message" transfer-ownership="none">
  3879. <doc xml:space="preserve">a #GstRTSPMessage</doc>
  3880. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  3881. </parameter>
  3882. <parameter name="id"
  3883. direction="out"
  3884. caller-allocates="0"
  3885. transfer-ownership="full"
  3886. optional="1"
  3887. allow-none="1">
  3888. <doc xml:space="preserve">location for a message ID or %NULL</doc>
  3889. <type name="guint" c:type="guint*"/>
  3890. </parameter>
  3891. </parameters>
  3892. </method>
  3893. <method name="set_flushing"
  3894. c:identifier="gst_rtsp_watch_set_flushing"
  3895. version="1.4">
  3896. <doc xml:space="preserve">When @flushing is %TRUE, abort a call to gst_rtsp_watch_wait_backlog()
  3897. and make sure gst_rtsp_watch_write_data() returns immediately with
  3898. #GST_RTSP_EINTR. And empty the queue.</doc>
  3899. <return-value transfer-ownership="none">
  3900. <type name="none" c:type="void"/>
  3901. </return-value>
  3902. <parameters>
  3903. <instance-parameter name="watch" transfer-ownership="none">
  3904. <doc xml:space="preserve">a #GstRTSPWatch</doc>
  3905. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  3906. </instance-parameter>
  3907. <parameter name="flushing" transfer-ownership="none">
  3908. <doc xml:space="preserve">new flushing state</doc>
  3909. <type name="gboolean" c:type="gboolean"/>
  3910. </parameter>
  3911. </parameters>
  3912. </method>
  3913. <method name="set_send_backlog"
  3914. c:identifier="gst_rtsp_watch_set_send_backlog"
  3915. version="1.2">
  3916. <doc xml:space="preserve">Set the maximum amount of bytes and messages that will be queued in @watch.
  3917. When the maximum amounts are exceeded, gst_rtsp_watch_write_data() and
  3918. gst_rtsp_watch_send_message() will return #GST_RTSP_ENOMEM.
  3919. A value of 0 for @bytes or @messages means no limits.</doc>
  3920. <return-value transfer-ownership="none">
  3921. <type name="none" c:type="void"/>
  3922. </return-value>
  3923. <parameters>
  3924. <instance-parameter name="watch" transfer-ownership="none">
  3925. <doc xml:space="preserve">a #GstRTSPWatch</doc>
  3926. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  3927. </instance-parameter>
  3928. <parameter name="bytes" transfer-ownership="none">
  3929. <doc xml:space="preserve">maximum bytes</doc>
  3930. <type name="gsize" c:type="gsize"/>
  3931. </parameter>
  3932. <parameter name="messages" transfer-ownership="none">
  3933. <doc xml:space="preserve">maximum messages</doc>
  3934. <type name="guint" c:type="guint"/>
  3935. </parameter>
  3936. </parameters>
  3937. </method>
  3938. <method name="unref" c:identifier="gst_rtsp_watch_unref">
  3939. <doc xml:space="preserve">Decreases the reference count of @watch by one. If the resulting reference
  3940. count is zero the watch and associated memory will be destroyed.</doc>
  3941. <return-value transfer-ownership="none">
  3942. <type name="none" c:type="void"/>
  3943. </return-value>
  3944. <parameters>
  3945. <instance-parameter name="watch" transfer-ownership="none">
  3946. <doc xml:space="preserve">a #GstRTSPWatch</doc>
  3947. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  3948. </instance-parameter>
  3949. </parameters>
  3950. </method>
  3951. <method name="wait_backlog"
  3952. c:identifier="gst_rtsp_watch_wait_backlog"
  3953. version="1.4">
  3954. <doc xml:space="preserve">Wait until there is place in the backlog queue, @timeout is reached
  3955. or @watch is set to flushing.
  3956. If @timeout is %NULL this function can block forever. If @timeout
  3957. contains a valid timeout, this function will return %GST_RTSP_ETIMEOUT
  3958. after the timeout expired.
  3959. The typically use of this function is when gst_rtsp_watch_write_data
  3960. returns %GST_RTSP_ENOMEM. The caller then calls this function to wait for
  3961. free space in the backlog queue and try again.</doc>
  3962. <return-value transfer-ownership="none">
  3963. <doc xml:space="preserve">%GST_RTSP_OK when if there is room in queue.
  3964. %GST_RTSP_ETIMEOUT when @timeout was reached.
  3965. %GST_RTSP_EINTR when @watch is flushing
  3966. %GST_RTSP_EINVAL when called with invalid parameters.</doc>
  3967. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3968. </return-value>
  3969. <parameters>
  3970. <instance-parameter name="watch" transfer-ownership="none">
  3971. <doc xml:space="preserve">a #GstRTSPWatch</doc>
  3972. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  3973. </instance-parameter>
  3974. <parameter name="timeout" transfer-ownership="none">
  3975. <doc xml:space="preserve">a #GTimeVal timeout</doc>
  3976. <type name="GLib.TimeVal" c:type="GTimeVal*"/>
  3977. </parameter>
  3978. </parameters>
  3979. </method>
  3980. <method name="write_data" c:identifier="gst_rtsp_watch_write_data">
  3981. <doc xml:space="preserve">Write @data using the connection of the @watch. If it cannot be sent
  3982. immediately, it will be queued for transmission in @watch. The contents of
  3983. @message will then be serialized and transmitted when the connection of the
  3984. @watch becomes writable. In case the @message is queued, the ID returned in
  3985. @id will be non-zero and used as the ID argument in the message_sent
  3986. callback.
  3987. This function will take ownership of @data and g_free() it after use.
  3988. If the amount of queued data exceeds the limits set with
  3989. gst_rtsp_watch_set_send_backlog(), this function will return
  3990. #GST_RTSP_ENOMEM.</doc>
  3991. <return-value transfer-ownership="none">
  3992. <doc xml:space="preserve">#GST_RTSP_OK on success. #GST_RTSP_ENOMEM when the backlog limits
  3993. are reached. #GST_RTSP_EINTR when @watch was flushing.</doc>
  3994. <type name="RTSPResult" c:type="GstRTSPResult"/>
  3995. </return-value>
  3996. <parameters>
  3997. <instance-parameter name="watch" transfer-ownership="none">
  3998. <doc xml:space="preserve">a #GstRTSPWatch</doc>
  3999. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4000. </instance-parameter>
  4001. <parameter name="data" transfer-ownership="full">
  4002. <doc xml:space="preserve">the data to queue</doc>
  4003. <array length="1" zero-terminated="0" c:type="guint8*">
  4004. <type name="guint8" c:type="guint8"/>
  4005. </array>
  4006. </parameter>
  4007. <parameter name="size" transfer-ownership="none">
  4008. <doc xml:space="preserve">the size of @data</doc>
  4009. <type name="guint" c:type="guint"/>
  4010. </parameter>
  4011. <parameter name="id"
  4012. direction="out"
  4013. caller-allocates="0"
  4014. transfer-ownership="full"
  4015. optional="1"
  4016. allow-none="1">
  4017. <doc xml:space="preserve">location for a message ID or %NULL</doc>
  4018. <type name="guint" c:type="guint*"/>
  4019. </parameter>
  4020. </parameters>
  4021. </method>
  4022. <function name="new"
  4023. c:identifier="gst_rtsp_watch_new"
  4024. introspectable="0">
  4025. <doc xml:space="preserve">Create a watch object for @conn. The functions provided in @funcs will be
  4026. called with @user_data when activity happened on the watch.
  4027. The new watch is usually created so that it can be attached to a
  4028. maincontext with gst_rtsp_watch_attach().
  4029. @conn must exist for the entire lifetime of the watch.</doc>
  4030. <return-value>
  4031. <doc xml:space="preserve">a #GstRTSPWatch that can be used for asynchronous RTSP
  4032. communication. Free with gst_rtsp_watch_unref () after usage.</doc>
  4033. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4034. </return-value>
  4035. <parameters>
  4036. <parameter name="conn" transfer-ownership="none">
  4037. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  4038. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  4039. </parameter>
  4040. <parameter name="funcs" transfer-ownership="none">
  4041. <doc xml:space="preserve">watch functions</doc>
  4042. <type name="RTSPWatchFuncs" c:type="GstRTSPWatchFuncs*"/>
  4043. </parameter>
  4044. <parameter name="user_data"
  4045. transfer-ownership="none"
  4046. nullable="1"
  4047. allow-none="1">
  4048. <doc xml:space="preserve">user data to pass to @funcs</doc>
  4049. <type name="gpointer" c:type="gpointer"/>
  4050. </parameter>
  4051. <parameter name="notify" transfer-ownership="none" scope="async">
  4052. <doc xml:space="preserve">notify when @user_data is not referenced anymore</doc>
  4053. <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
  4054. </parameter>
  4055. </parameters>
  4056. </function>
  4057. </record>
  4058. <record name="RTSPWatchFuncs" c:type="GstRTSPWatchFuncs">
  4059. <doc xml:space="preserve">Callback functions from a #GstRTSPWatch.</doc>
  4060. <field name="message_received">
  4061. <callback name="message_received">
  4062. <return-value transfer-ownership="none">
  4063. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4064. </return-value>
  4065. <parameters>
  4066. <parameter name="watch" transfer-ownership="none">
  4067. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4068. </parameter>
  4069. <parameter name="message" transfer-ownership="none">
  4070. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  4071. </parameter>
  4072. <parameter name="user_data"
  4073. transfer-ownership="none"
  4074. nullable="1"
  4075. allow-none="1"
  4076. closure="2">
  4077. <type name="gpointer" c:type="gpointer"/>
  4078. </parameter>
  4079. </parameters>
  4080. </callback>
  4081. </field>
  4082. <field name="message_sent">
  4083. <callback name="message_sent">
  4084. <return-value transfer-ownership="none">
  4085. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4086. </return-value>
  4087. <parameters>
  4088. <parameter name="watch" transfer-ownership="none">
  4089. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4090. </parameter>
  4091. <parameter name="id" transfer-ownership="none">
  4092. <type name="guint" c:type="guint"/>
  4093. </parameter>
  4094. <parameter name="user_data"
  4095. transfer-ownership="none"
  4096. nullable="1"
  4097. allow-none="1"
  4098. closure="2">
  4099. <type name="gpointer" c:type="gpointer"/>
  4100. </parameter>
  4101. </parameters>
  4102. </callback>
  4103. </field>
  4104. <field name="closed">
  4105. <callback name="closed">
  4106. <return-value transfer-ownership="none">
  4107. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4108. </return-value>
  4109. <parameters>
  4110. <parameter name="watch" transfer-ownership="none">
  4111. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4112. </parameter>
  4113. <parameter name="user_data"
  4114. transfer-ownership="none"
  4115. nullable="1"
  4116. allow-none="1"
  4117. closure="1">
  4118. <type name="gpointer" c:type="gpointer"/>
  4119. </parameter>
  4120. </parameters>
  4121. </callback>
  4122. </field>
  4123. <field name="error">
  4124. <callback name="error">
  4125. <return-value transfer-ownership="none">
  4126. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4127. </return-value>
  4128. <parameters>
  4129. <parameter name="watch" transfer-ownership="none">
  4130. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4131. </parameter>
  4132. <parameter name="result" transfer-ownership="none">
  4133. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4134. </parameter>
  4135. <parameter name="user_data"
  4136. transfer-ownership="none"
  4137. nullable="1"
  4138. allow-none="1"
  4139. closure="2">
  4140. <type name="gpointer" c:type="gpointer"/>
  4141. </parameter>
  4142. </parameters>
  4143. </callback>
  4144. </field>
  4145. <field name="tunnel_start">
  4146. <callback name="tunnel_start">
  4147. <return-value transfer-ownership="none">
  4148. <type name="RTSPStatusCode" c:type="GstRTSPStatusCode"/>
  4149. </return-value>
  4150. <parameters>
  4151. <parameter name="watch" transfer-ownership="none">
  4152. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4153. </parameter>
  4154. <parameter name="user_data"
  4155. transfer-ownership="none"
  4156. nullable="1"
  4157. allow-none="1"
  4158. closure="1">
  4159. <type name="gpointer" c:type="gpointer"/>
  4160. </parameter>
  4161. </parameters>
  4162. </callback>
  4163. </field>
  4164. <field name="tunnel_complete">
  4165. <callback name="tunnel_complete">
  4166. <return-value transfer-ownership="none">
  4167. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4168. </return-value>
  4169. <parameters>
  4170. <parameter name="watch" transfer-ownership="none">
  4171. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4172. </parameter>
  4173. <parameter name="user_data"
  4174. transfer-ownership="none"
  4175. nullable="1"
  4176. allow-none="1"
  4177. closure="1">
  4178. <type name="gpointer" c:type="gpointer"/>
  4179. </parameter>
  4180. </parameters>
  4181. </callback>
  4182. </field>
  4183. <field name="error_full">
  4184. <callback name="error_full">
  4185. <return-value transfer-ownership="none">
  4186. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4187. </return-value>
  4188. <parameters>
  4189. <parameter name="watch" transfer-ownership="none">
  4190. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4191. </parameter>
  4192. <parameter name="result" transfer-ownership="none">
  4193. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4194. </parameter>
  4195. <parameter name="message" transfer-ownership="none">
  4196. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  4197. </parameter>
  4198. <parameter name="id" transfer-ownership="none">
  4199. <type name="guint" c:type="guint"/>
  4200. </parameter>
  4201. <parameter name="user_data"
  4202. transfer-ownership="none"
  4203. nullable="1"
  4204. allow-none="1"
  4205. closure="4">
  4206. <type name="gpointer" c:type="gpointer"/>
  4207. </parameter>
  4208. </parameters>
  4209. </callback>
  4210. </field>
  4211. <field name="tunnel_lost">
  4212. <callback name="tunnel_lost">
  4213. <return-value transfer-ownership="none">
  4214. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4215. </return-value>
  4216. <parameters>
  4217. <parameter name="watch" transfer-ownership="none">
  4218. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4219. </parameter>
  4220. <parameter name="user_data"
  4221. transfer-ownership="none"
  4222. nullable="1"
  4223. allow-none="1"
  4224. closure="1">
  4225. <type name="gpointer" c:type="gpointer"/>
  4226. </parameter>
  4227. </parameters>
  4228. </callback>
  4229. </field>
  4230. <field name="tunnel_http_response">
  4231. <callback name="tunnel_http_response">
  4232. <return-value transfer-ownership="none">
  4233. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4234. </return-value>
  4235. <parameters>
  4236. <parameter name="watch" transfer-ownership="none">
  4237. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4238. </parameter>
  4239. <parameter name="request" transfer-ownership="none">
  4240. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  4241. </parameter>
  4242. <parameter name="response" transfer-ownership="none">
  4243. <type name="RTSPMessage" c:type="GstRTSPMessage*"/>
  4244. </parameter>
  4245. <parameter name="user_data"
  4246. transfer-ownership="none"
  4247. nullable="1"
  4248. allow-none="1"
  4249. closure="3">
  4250. <type name="gpointer" c:type="gpointer"/>
  4251. </parameter>
  4252. </parameters>
  4253. </callback>
  4254. </field>
  4255. <field name="_gst_reserved" readable="0" private="1">
  4256. <array zero-terminated="0" c:type="gpointer" fixed-size="3">
  4257. <type name="gpointer" c:type="gpointer"/>
  4258. </array>
  4259. </field>
  4260. </record>
  4261. <constant name="RTSP_DEFAULT_PORT"
  4262. value="554"
  4263. c:type="GST_RTSP_DEFAULT_PORT">
  4264. <doc xml:space="preserve">The default RTSP port to connect to.</doc>
  4265. <type name="gint" c:type="gint"/>
  4266. </constant>
  4267. <function name="rtsp_connection_accept"
  4268. c:identifier="gst_rtsp_connection_accept"
  4269. moved-to="RTSPConnection.accept">
  4270. <doc xml:space="preserve">Accept a new connection on @socket and create a new #GstRTSPConnection for
  4271. handling communication on new socket.</doc>
  4272. <return-value transfer-ownership="none">
  4273. <doc xml:space="preserve">#GST_RTSP_OK when @conn contains a valid connection.</doc>
  4274. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4275. </return-value>
  4276. <parameters>
  4277. <parameter name="socket" transfer-ownership="none">
  4278. <doc xml:space="preserve">a socket</doc>
  4279. <type name="Gio.Socket" c:type="GSocket*"/>
  4280. </parameter>
  4281. <parameter name="conn"
  4282. direction="out"
  4283. caller-allocates="0"
  4284. transfer-ownership="full">
  4285. <doc xml:space="preserve">storage for a #GstRTSPConnection</doc>
  4286. <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
  4287. </parameter>
  4288. <parameter name="cancellable"
  4289. transfer-ownership="none"
  4290. nullable="1"
  4291. allow-none="1">
  4292. <doc xml:space="preserve">a #GCancellable to cancel the operation</doc>
  4293. <type name="Gio.Cancellable" c:type="GCancellable*"/>
  4294. </parameter>
  4295. </parameters>
  4296. </function>
  4297. <function name="rtsp_connection_create"
  4298. c:identifier="gst_rtsp_connection_create"
  4299. moved-to="RTSPConnection.create">
  4300. <doc xml:space="preserve">Create a newly allocated #GstRTSPConnection from @url and store it in @conn.
  4301. The connection will not yet attempt to connect to @url, use
  4302. gst_rtsp_connection_connect().
  4303. A copy of @url will be made.</doc>
  4304. <return-value transfer-ownership="none">
  4305. <doc xml:space="preserve">#GST_RTSP_OK when @conn contains a valid connection.</doc>
  4306. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4307. </return-value>
  4308. <parameters>
  4309. <parameter name="url" transfer-ownership="none">
  4310. <doc xml:space="preserve">a #GstRTSPUrl</doc>
  4311. <type name="RTSPUrl" c:type="const GstRTSPUrl*"/>
  4312. </parameter>
  4313. <parameter name="conn"
  4314. direction="out"
  4315. caller-allocates="0"
  4316. transfer-ownership="full">
  4317. <doc xml:space="preserve">storage for a #GstRTSPConnection</doc>
  4318. <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
  4319. </parameter>
  4320. </parameters>
  4321. </function>
  4322. <function name="rtsp_connection_create_from_socket"
  4323. c:identifier="gst_rtsp_connection_create_from_socket"
  4324. moved-to="RTSPConnection.create_from_socket">
  4325. <doc xml:space="preserve">Create a new #GstRTSPConnection for handling communication on the existing
  4326. socket @socket. The @initial_buffer contains zero terminated data already
  4327. read from @socket which should be used before starting to read new data.</doc>
  4328. <return-value transfer-ownership="none">
  4329. <doc xml:space="preserve">#GST_RTSP_OK when @conn contains a valid connection.</doc>
  4330. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4331. </return-value>
  4332. <parameters>
  4333. <parameter name="socket" transfer-ownership="none">
  4334. <doc xml:space="preserve">a #GSocket</doc>
  4335. <type name="Gio.Socket" c:type="GSocket*"/>
  4336. </parameter>
  4337. <parameter name="ip" transfer-ownership="none">
  4338. <doc xml:space="preserve">the IP address of the other end</doc>
  4339. <type name="utf8" c:type="const gchar*"/>
  4340. </parameter>
  4341. <parameter name="port" transfer-ownership="none">
  4342. <doc xml:space="preserve">the port used by the other end</doc>
  4343. <type name="guint16" c:type="guint16"/>
  4344. </parameter>
  4345. <parameter name="initial_buffer" transfer-ownership="none">
  4346. <doc xml:space="preserve">data already read from @fd</doc>
  4347. <type name="utf8" c:type="const gchar*"/>
  4348. </parameter>
  4349. <parameter name="conn"
  4350. direction="out"
  4351. caller-allocates="0"
  4352. transfer-ownership="full">
  4353. <doc xml:space="preserve">storage for a #GstRTSPConnection</doc>
  4354. <type name="RTSPConnection" c:type="GstRTSPConnection**"/>
  4355. </parameter>
  4356. </parameters>
  4357. </function>
  4358. <function name="rtsp_find_header_field"
  4359. c:identifier="gst_rtsp_find_header_field">
  4360. <doc xml:space="preserve">Convert @header to a #GstRTSPHeaderField.</doc>
  4361. <return-value transfer-ownership="none">
  4362. <doc xml:space="preserve">a #GstRTSPHeaderField for @header or #GST_RTSP_HDR_INVALID if the
  4363. header field is unknown.</doc>
  4364. <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
  4365. </return-value>
  4366. <parameters>
  4367. <parameter name="header" transfer-ownership="none">
  4368. <doc xml:space="preserve">a header string</doc>
  4369. <type name="utf8" c:type="const gchar*"/>
  4370. </parameter>
  4371. </parameters>
  4372. </function>
  4373. <function name="rtsp_find_method" c:identifier="gst_rtsp_find_method">
  4374. <doc xml:space="preserve">Convert @method to a #GstRTSPMethod.</doc>
  4375. <return-value transfer-ownership="none">
  4376. <doc xml:space="preserve">a #GstRTSPMethod for @method or #GST_RTSP_INVALID if the
  4377. method is unknown.</doc>
  4378. <type name="RTSPMethod" c:type="GstRTSPMethod"/>
  4379. </return-value>
  4380. <parameters>
  4381. <parameter name="method" transfer-ownership="none">
  4382. <doc xml:space="preserve">a method</doc>
  4383. <type name="utf8" c:type="const gchar*"/>
  4384. </parameter>
  4385. </parameters>
  4386. </function>
  4387. <function name="rtsp_header_allow_multiple"
  4388. c:identifier="gst_rtsp_header_allow_multiple">
  4389. <doc xml:space="preserve">Check whether @field may appear multiple times in a message.</doc>
  4390. <return-value transfer-ownership="none">
  4391. <doc xml:space="preserve">%TRUE if multiple headers are allowed.</doc>
  4392. <type name="gboolean" c:type="gboolean"/>
  4393. </return-value>
  4394. <parameters>
  4395. <parameter name="field" transfer-ownership="none">
  4396. <doc xml:space="preserve">a #GstRTSPHeaderField</doc>
  4397. <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
  4398. </parameter>
  4399. </parameters>
  4400. </function>
  4401. <function name="rtsp_header_as_text"
  4402. c:identifier="gst_rtsp_header_as_text">
  4403. <doc xml:space="preserve">Convert @field to a string.</doc>
  4404. <return-value transfer-ownership="none">
  4405. <doc xml:space="preserve">a string representation of @field.</doc>
  4406. <type name="utf8" c:type="const gchar*"/>
  4407. </return-value>
  4408. <parameters>
  4409. <parameter name="field" transfer-ownership="none">
  4410. <doc xml:space="preserve">a #GstRTSPHeaderField</doc>
  4411. <type name="RTSPHeaderField" c:type="GstRTSPHeaderField"/>
  4412. </parameter>
  4413. </parameters>
  4414. </function>
  4415. <function name="rtsp_message_new"
  4416. c:identifier="gst_rtsp_message_new"
  4417. moved-to="RTSPMessage.new">
  4418. <doc xml:space="preserve">Create a new initialized #GstRTSPMessage. Free with gst_rtsp_message_free().</doc>
  4419. <return-value transfer-ownership="none">
  4420. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  4421. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4422. </return-value>
  4423. <parameters>
  4424. <parameter name="msg"
  4425. direction="out"
  4426. caller-allocates="0"
  4427. transfer-ownership="full">
  4428. <doc xml:space="preserve">a location for the new #GstRTSPMessage</doc>
  4429. <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
  4430. </parameter>
  4431. </parameters>
  4432. </function>
  4433. <function name="rtsp_message_new_data"
  4434. c:identifier="gst_rtsp_message_new_data"
  4435. moved-to="RTSPMessage.new_data">
  4436. <doc xml:space="preserve">Create a new data #GstRTSPMessage with @channel and store the
  4437. result message in @msg. Free with gst_rtsp_message_free().</doc>
  4438. <return-value transfer-ownership="none">
  4439. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  4440. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4441. </return-value>
  4442. <parameters>
  4443. <parameter name="msg"
  4444. direction="out"
  4445. caller-allocates="0"
  4446. transfer-ownership="full">
  4447. <doc xml:space="preserve">a location for the new #GstRTSPMessage</doc>
  4448. <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
  4449. </parameter>
  4450. <parameter name="channel" transfer-ownership="none">
  4451. <doc xml:space="preserve">the channel</doc>
  4452. <type name="guint8" c:type="guint8"/>
  4453. </parameter>
  4454. </parameters>
  4455. </function>
  4456. <function name="rtsp_message_new_request"
  4457. c:identifier="gst_rtsp_message_new_request"
  4458. moved-to="RTSPMessage.new_request">
  4459. <doc xml:space="preserve">Create a new #GstRTSPMessage with @method and @uri and store the result
  4460. request message in @msg. Free with gst_rtsp_message_free().</doc>
  4461. <return-value transfer-ownership="none">
  4462. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  4463. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4464. </return-value>
  4465. <parameters>
  4466. <parameter name="msg"
  4467. direction="out"
  4468. caller-allocates="0"
  4469. transfer-ownership="full">
  4470. <doc xml:space="preserve">a location for the new #GstRTSPMessage</doc>
  4471. <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
  4472. </parameter>
  4473. <parameter name="method" transfer-ownership="none">
  4474. <doc xml:space="preserve">the request method to use</doc>
  4475. <type name="RTSPMethod" c:type="GstRTSPMethod"/>
  4476. </parameter>
  4477. <parameter name="uri" transfer-ownership="none">
  4478. <doc xml:space="preserve">the uri of the request</doc>
  4479. <type name="utf8" c:type="const gchar*"/>
  4480. </parameter>
  4481. </parameters>
  4482. </function>
  4483. <function name="rtsp_message_new_response"
  4484. c:identifier="gst_rtsp_message_new_response"
  4485. moved-to="RTSPMessage.new_response">
  4486. <doc xml:space="preserve">Create a new response #GstRTSPMessage with @code and @reason and store the
  4487. result message in @msg. Free with gst_rtsp_message_free().
  4488. When @reason is #NULL, the default reason for @code will be used.
  4489. When @request is not #NULL, the relevant headers will be copied to the new
  4490. response message.</doc>
  4491. <return-value transfer-ownership="none">
  4492. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  4493. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4494. </return-value>
  4495. <parameters>
  4496. <parameter name="msg"
  4497. direction="out"
  4498. caller-allocates="0"
  4499. transfer-ownership="full">
  4500. <doc xml:space="preserve">a location for the new #GstRTSPMessage</doc>
  4501. <type name="RTSPMessage" c:type="GstRTSPMessage**"/>
  4502. </parameter>
  4503. <parameter name="code" transfer-ownership="none">
  4504. <doc xml:space="preserve">the status code</doc>
  4505. <type name="RTSPStatusCode" c:type="GstRTSPStatusCode"/>
  4506. </parameter>
  4507. <parameter name="reason"
  4508. transfer-ownership="none"
  4509. nullable="1"
  4510. allow-none="1">
  4511. <doc xml:space="preserve">the status reason or %NULL</doc>
  4512. <type name="utf8" c:type="const gchar*"/>
  4513. </parameter>
  4514. <parameter name="request"
  4515. transfer-ownership="none"
  4516. nullable="1"
  4517. allow-none="1">
  4518. <doc xml:space="preserve">the request that triggered the response or %NULL</doc>
  4519. <type name="RTSPMessage" c:type="const GstRTSPMessage*"/>
  4520. </parameter>
  4521. </parameters>
  4522. </function>
  4523. <function name="rtsp_method_as_text"
  4524. c:identifier="gst_rtsp_method_as_text"
  4525. moved-to="RTSPMethod.as_text">
  4526. <doc xml:space="preserve">Convert @method to a string.</doc>
  4527. <return-value transfer-ownership="none">
  4528. <doc xml:space="preserve">a string representation of @method.</doc>
  4529. <type name="utf8" c:type="const gchar*"/>
  4530. </return-value>
  4531. <parameters>
  4532. <parameter name="method" transfer-ownership="none">
  4533. <doc xml:space="preserve">a #GstRTSPMethod</doc>
  4534. <type name="RTSPMethod" c:type="GstRTSPMethod"/>
  4535. </parameter>
  4536. </parameters>
  4537. </function>
  4538. <function name="rtsp_options_as_text"
  4539. c:identifier="gst_rtsp_options_as_text">
  4540. <doc xml:space="preserve">Convert @options to a string.</doc>
  4541. <return-value transfer-ownership="full">
  4542. <doc xml:space="preserve">a new string of @options. g_free() after usage.</doc>
  4543. <type name="utf8" c:type="gchar*"/>
  4544. </return-value>
  4545. <parameters>
  4546. <parameter name="options" transfer-ownership="none">
  4547. <doc xml:space="preserve">one or more #GstRTSPMethod</doc>
  4548. <type name="RTSPMethod" c:type="GstRTSPMethod"/>
  4549. </parameter>
  4550. </parameters>
  4551. </function>
  4552. <function name="rtsp_options_from_text"
  4553. c:identifier="gst_rtsp_options_from_text"
  4554. version="1.2">
  4555. <doc xml:space="preserve">Convert the comma separated list @options to a #GstRTSPMethod bitwise or
  4556. of methods. This functions is the reverse of gst_rtsp_options_as_text().</doc>
  4557. <return-value transfer-ownership="none">
  4558. <doc xml:space="preserve">a #GstRTSPMethod</doc>
  4559. <type name="RTSPMethod" c:type="GstRTSPMethod"/>
  4560. </return-value>
  4561. <parameters>
  4562. <parameter name="options" transfer-ownership="none">
  4563. <doc xml:space="preserve">a comma separated list of options</doc>
  4564. <type name="utf8" c:type="const gchar*"/>
  4565. </parameter>
  4566. </parameters>
  4567. </function>
  4568. <function name="rtsp_range_convert_units"
  4569. c:identifier="gst_rtsp_range_convert_units"
  4570. moved-to="RTSPRange.convert_units">
  4571. <doc xml:space="preserve">Converts the range in-place between different types of units.
  4572. Ranges containing the special value #GST_RTSP_TIME_NOW can not be
  4573. converted as these are only valid for #GST_RTSP_RANGE_NPT.</doc>
  4574. <return-value transfer-ownership="none">
  4575. <doc xml:space="preserve">%TRUE if the range could be converted</doc>
  4576. <type name="gboolean" c:type="gboolean"/>
  4577. </return-value>
  4578. <parameters>
  4579. <parameter name="range" transfer-ownership="none">
  4580. <doc xml:space="preserve">a #GstRTSPTimeRange</doc>
  4581. <type name="RTSPTimeRange" c:type="GstRTSPTimeRange*"/>
  4582. </parameter>
  4583. <parameter name="unit" transfer-ownership="none">
  4584. <doc xml:space="preserve">the unit to convert the range into</doc>
  4585. <type name="RTSPRangeUnit" c:type="GstRTSPRangeUnit"/>
  4586. </parameter>
  4587. </parameters>
  4588. </function>
  4589. <function name="rtsp_range_free"
  4590. c:identifier="gst_rtsp_range_free"
  4591. moved-to="RTSPRange.free">
  4592. <doc xml:space="preserve">Free the memory allocated by @range.</doc>
  4593. <return-value transfer-ownership="none">
  4594. <type name="none" c:type="void"/>
  4595. </return-value>
  4596. <parameters>
  4597. <parameter name="range" transfer-ownership="none">
  4598. <doc xml:space="preserve">a #GstRTSPTimeRange</doc>
  4599. <type name="RTSPTimeRange" c:type="GstRTSPTimeRange*"/>
  4600. </parameter>
  4601. </parameters>
  4602. </function>
  4603. <function name="rtsp_range_get_times"
  4604. c:identifier="gst_rtsp_range_get_times"
  4605. moved-to="RTSPRange.get_times"
  4606. version="1.2">
  4607. <doc xml:space="preserve">Retrieve the minimum and maximum values from @range converted to
  4608. #GstClockTime in @min and @max.
  4609. A value of %GST_CLOCK_TIME_NONE will be used to signal #GST_RTSP_TIME_NOW
  4610. and #GST_RTSP_TIME_END for @min and @max respectively.
  4611. UTC times will be converted to nanoseconds since 1900.</doc>
  4612. <return-value transfer-ownership="none">
  4613. <doc xml:space="preserve">%TRUE on success.</doc>
  4614. <type name="gboolean" c:type="gboolean"/>
  4615. </return-value>
  4616. <parameters>
  4617. <parameter name="range" transfer-ownership="none">
  4618. <doc xml:space="preserve">a #GstRTSPTimeRange</doc>
  4619. <type name="RTSPTimeRange" c:type="const GstRTSPTimeRange*"/>
  4620. </parameter>
  4621. <parameter name="min" transfer-ownership="none">
  4622. <doc xml:space="preserve">result minimum #GstClockTime</doc>
  4623. <type name="Gst.ClockTime" c:type="GstClockTime*"/>
  4624. </parameter>
  4625. <parameter name="max" transfer-ownership="none">
  4626. <doc xml:space="preserve">result maximum #GstClockTime</doc>
  4627. <type name="Gst.ClockTime" c:type="GstClockTime*"/>
  4628. </parameter>
  4629. </parameters>
  4630. </function>
  4631. <function name="rtsp_range_parse"
  4632. c:identifier="gst_rtsp_range_parse"
  4633. moved-to="RTSPRange.parse">
  4634. <doc xml:space="preserve">Parse @rangestr to a #GstRTSPTimeRange.</doc>
  4635. <return-value transfer-ownership="none">
  4636. <doc xml:space="preserve">#GST_RTSP_OK on success.</doc>
  4637. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4638. </return-value>
  4639. <parameters>
  4640. <parameter name="rangestr" transfer-ownership="none">
  4641. <doc xml:space="preserve">a range string to parse</doc>
  4642. <type name="utf8" c:type="const gchar*"/>
  4643. </parameter>
  4644. <parameter name="range" transfer-ownership="none">
  4645. <doc xml:space="preserve">location to hold the #GstRTSPTimeRange result</doc>
  4646. <type name="RTSPTimeRange" c:type="GstRTSPTimeRange**"/>
  4647. </parameter>
  4648. </parameters>
  4649. </function>
  4650. <function name="rtsp_range_to_string"
  4651. c:identifier="gst_rtsp_range_to_string"
  4652. moved-to="RTSPRange.to_string">
  4653. <doc xml:space="preserve">Convert @range into a string representation.</doc>
  4654. <return-value transfer-ownership="full">
  4655. <doc xml:space="preserve">The string representation of @range. g_free() after usage.</doc>
  4656. <type name="utf8" c:type="gchar*"/>
  4657. </return-value>
  4658. <parameters>
  4659. <parameter name="range" transfer-ownership="none">
  4660. <doc xml:space="preserve">a #GstRTSPTimeRange</doc>
  4661. <type name="RTSPTimeRange" c:type="const GstRTSPTimeRange*"/>
  4662. </parameter>
  4663. </parameters>
  4664. </function>
  4665. <function name="rtsp_status_as_text"
  4666. c:identifier="gst_rtsp_status_as_text">
  4667. <doc xml:space="preserve">Convert @code to a string.</doc>
  4668. <return-value transfer-ownership="none">
  4669. <doc xml:space="preserve">a string representation of @code.</doc>
  4670. <type name="utf8" c:type="const gchar*"/>
  4671. </return-value>
  4672. <parameters>
  4673. <parameter name="code" transfer-ownership="none">
  4674. <doc xml:space="preserve">a #GstRTSPStatusCode</doc>
  4675. <type name="RTSPStatusCode" c:type="GstRTSPStatusCode"/>
  4676. </parameter>
  4677. </parameters>
  4678. </function>
  4679. <function name="rtsp_strresult" c:identifier="gst_rtsp_strresult">
  4680. <doc xml:space="preserve">Convert @result in a human readable string.</doc>
  4681. <return-value transfer-ownership="full">
  4682. <doc xml:space="preserve">a newly allocated string. g_free() after usage.</doc>
  4683. <type name="utf8" c:type="gchar*"/>
  4684. </return-value>
  4685. <parameters>
  4686. <parameter name="result" transfer-ownership="none">
  4687. <doc xml:space="preserve">a #GstRTSPResult</doc>
  4688. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4689. </parameter>
  4690. </parameters>
  4691. </function>
  4692. <function name="rtsp_transport_get_manager"
  4693. c:identifier="gst_rtsp_transport_get_manager"
  4694. moved-to="RTSPTransport.get_manager">
  4695. <doc xml:space="preserve">Get the #GstElement that can handle the buffers transported over @trans.
  4696. It is possible that there are several managers available, use @option to
  4697. selected one.
  4698. @manager will contain an element name or #NULL when no manager is
  4699. needed/available for @trans.</doc>
  4700. <return-value transfer-ownership="none">
  4701. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  4702. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4703. </return-value>
  4704. <parameters>
  4705. <parameter name="trans" transfer-ownership="none">
  4706. <doc xml:space="preserve">a #GstRTSPTransMode</doc>
  4707. <type name="RTSPTransMode" c:type="GstRTSPTransMode"/>
  4708. </parameter>
  4709. <parameter name="manager" transfer-ownership="none">
  4710. <doc xml:space="preserve">location to hold the result</doc>
  4711. <type name="utf8" c:type="const gchar**"/>
  4712. </parameter>
  4713. <parameter name="option" transfer-ownership="none">
  4714. <doc xml:space="preserve">option index.</doc>
  4715. <type name="guint" c:type="guint"/>
  4716. </parameter>
  4717. </parameters>
  4718. </function>
  4719. <function name="rtsp_transport_get_mime"
  4720. c:identifier="gst_rtsp_transport_get_mime"
  4721. moved-to="RTSPTransport.get_mime"
  4722. deprecated="1">
  4723. <doc xml:space="preserve">Get the mime type of the transport mode @trans. This mime type is typically
  4724. used to generate #GstCaps events.</doc>
  4725. <doc-deprecated xml:space="preserve">This functions only deals with the GstRTSPTransMode and only
  4726. returns the mime type for #GST_RTSP_PROFILE_AVP. Use
  4727. gst_rtsp_transport_get_media_type() instead.</doc-deprecated>
  4728. <return-value transfer-ownership="none">
  4729. <doc xml:space="preserve">#GST_RTSP_OK.</doc>
  4730. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4731. </return-value>
  4732. <parameters>
  4733. <parameter name="trans" transfer-ownership="none">
  4734. <doc xml:space="preserve">a #GstRTSPTransMode</doc>
  4735. <type name="RTSPTransMode" c:type="GstRTSPTransMode"/>
  4736. </parameter>
  4737. <parameter name="mime" transfer-ownership="none">
  4738. <doc xml:space="preserve">location to hold the result</doc>
  4739. <type name="utf8" c:type="const gchar**"/>
  4740. </parameter>
  4741. </parameters>
  4742. </function>
  4743. <function name="rtsp_transport_new"
  4744. c:identifier="gst_rtsp_transport_new"
  4745. moved-to="RTSPTransport.new">
  4746. <doc xml:space="preserve">Allocate a new initialized #GstRTSPTransport. Use gst_rtsp_transport_free()
  4747. after usage.</doc>
  4748. <return-value transfer-ownership="none">
  4749. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  4750. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4751. </return-value>
  4752. <parameters>
  4753. <parameter name="transport" transfer-ownership="none">
  4754. <doc xml:space="preserve">location to hold the new #GstRTSPTransport</doc>
  4755. <type name="RTSPTransport" c:type="GstRTSPTransport**"/>
  4756. </parameter>
  4757. </parameters>
  4758. </function>
  4759. <function name="rtsp_transport_parse"
  4760. c:identifier="gst_rtsp_transport_parse"
  4761. moved-to="RTSPTransport.parse">
  4762. <doc xml:space="preserve">Parse the RTSP transport string @str into @transport.</doc>
  4763. <return-value transfer-ownership="none">
  4764. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  4765. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4766. </return-value>
  4767. <parameters>
  4768. <parameter name="str" transfer-ownership="none">
  4769. <doc xml:space="preserve">a transport string</doc>
  4770. <type name="utf8" c:type="const gchar*"/>
  4771. </parameter>
  4772. <parameter name="transport" transfer-ownership="none">
  4773. <doc xml:space="preserve">a #GstRTSPTransport</doc>
  4774. <type name="RTSPTransport" c:type="GstRTSPTransport*"/>
  4775. </parameter>
  4776. </parameters>
  4777. </function>
  4778. <function name="rtsp_url_parse"
  4779. c:identifier="gst_rtsp_url_parse"
  4780. moved-to="RTSPUrl.parse">
  4781. <doc xml:space="preserve">Parse the RTSP @urlstr into a newly allocated #GstRTSPUrl. Free after usage
  4782. with gst_rtsp_url_free().</doc>
  4783. <return-value transfer-ownership="none">
  4784. <doc xml:space="preserve">a #GstRTSPResult.</doc>
  4785. <type name="RTSPResult" c:type="GstRTSPResult"/>
  4786. </return-value>
  4787. <parameters>
  4788. <parameter name="urlstr" transfer-ownership="none">
  4789. <doc xml:space="preserve">the url string to parse</doc>
  4790. <type name="utf8" c:type="const gchar*"/>
  4791. </parameter>
  4792. <parameter name="url"
  4793. direction="out"
  4794. caller-allocates="0"
  4795. transfer-ownership="full">
  4796. <doc xml:space="preserve">location to hold the result.</doc>
  4797. <type name="RTSPUrl" c:type="GstRTSPUrl**"/>
  4798. </parameter>
  4799. </parameters>
  4800. </function>
  4801. <function name="rtsp_version_as_text"
  4802. c:identifier="gst_rtsp_version_as_text"
  4803. moved-to="RTSPVersion.as_text">
  4804. <doc xml:space="preserve">Convert @version to a string.</doc>
  4805. <return-value transfer-ownership="none">
  4806. <doc xml:space="preserve">a string representation of @version.</doc>
  4807. <type name="utf8" c:type="const gchar*"/>
  4808. </return-value>
  4809. <parameters>
  4810. <parameter name="version" transfer-ownership="none">
  4811. <doc xml:space="preserve">a #GstRTSPVersion</doc>
  4812. <type name="RTSPVersion" c:type="GstRTSPVersion"/>
  4813. </parameter>
  4814. </parameters>
  4815. </function>
  4816. <function name="rtsp_watch_new"
  4817. c:identifier="gst_rtsp_watch_new"
  4818. moved-to="RTSPWatch.new"
  4819. introspectable="0">
  4820. <doc xml:space="preserve">Create a watch object for @conn. The functions provided in @funcs will be
  4821. called with @user_data when activity happened on the watch.
  4822. The new watch is usually created so that it can be attached to a
  4823. maincontext with gst_rtsp_watch_attach().
  4824. @conn must exist for the entire lifetime of the watch.</doc>
  4825. <return-value>
  4826. <doc xml:space="preserve">a #GstRTSPWatch that can be used for asynchronous RTSP
  4827. communication. Free with gst_rtsp_watch_unref () after usage.</doc>
  4828. <type name="RTSPWatch" c:type="GstRTSPWatch*"/>
  4829. </return-value>
  4830. <parameters>
  4831. <parameter name="conn" transfer-ownership="none">
  4832. <doc xml:space="preserve">a #GstRTSPConnection</doc>
  4833. <type name="RTSPConnection" c:type="GstRTSPConnection*"/>
  4834. </parameter>
  4835. <parameter name="funcs" transfer-ownership="none">
  4836. <doc xml:space="preserve">watch functions</doc>
  4837. <type name="RTSPWatchFuncs" c:type="GstRTSPWatchFuncs*"/>
  4838. </parameter>
  4839. <parameter name="user_data"
  4840. transfer-ownership="none"
  4841. nullable="1"
  4842. allow-none="1">
  4843. <doc xml:space="preserve">user data to pass to @funcs</doc>
  4844. <type name="gpointer" c:type="gpointer"/>
  4845. </parameter>
  4846. <parameter name="notify" transfer-ownership="none" scope="async">
  4847. <doc xml:space="preserve">notify when @user_data is not referenced anymore</doc>
  4848. <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
  4849. </parameter>
  4850. </parameters>
  4851. </function>
  4852. </namespace>
  4853. </repository>